Baixando dependências com ServiceNow SDK

Baixe dependências da aplicação e definições de typescript de uma instância para IntelliSense e validação de scripts e. ServiceNow Fluentcódigo.

Em todo o processo de desenvolvimento, você deve baixar dependências e definições de typescript de uma instância para oferecer suporte à codificação em relação a essas dependências em uma aplicação.

Para baixar todos os scripts e. ServiceNow Fluentpara uma aplicação, você pode usar o. dependências comando sem parâmetros. Se necessário, forneça o diretório da aplicação e o alias de autenticação também.

now-sdk dependencies [--directory <package path>] [--auth <alias>]

Download ServiceNow Fluentdependências da aplicação

Faça o download de definições de typescript para dependências em outros escopos de aplicações para obter suporte e validação do IntelliSense ServiceNow Fluentcódigo.

Antes de Iniciar

Adicione uma aplicação ao seu sistema local com ServiceNow SDK. Para obter mais informações, consulte Adicionando aplicações com ServiceNow SDK.

Função necessária: administrador

Por Que e Quando Desempenhar Esta Tarefa

Este procedimento usa o. ServiceNow SDKInterface de linha de comando (CLI). Em uma ferramenta de linha de comando, insira now-sdk --help para obter informações sobre os comandos disponíveis e opções globais. Para obter informações adicionais sobre um comando e seus parâmetros, insira o comando e. --help ou -h . Por exemplo, now-sdk auth --help . Para obter mais informações sobre a CLI, consulte ServiceNow SDK CLI.

Procedimento

1. Em Visual Studio Code, abra o diretório da aplicação com escopo.
2. Em now.config.json arquivo, adicione os itens dos quais sua aplicação depende no dependências objeto.

   . dependências o objeto tem a seguinte estrutura. Você deve especificar o escopo da aplicação e o tipo de dependência e os nomes ou sys_ids. Somente tabelas e funções podem ser especificadas por nome. Você pode usar um curinga ( * ) para adicionar todos os itens de uma tabela e escopo especificados.

   "dependencies": {
       "<scope>": {
         "<type>": ["<sys_id or name>"],
         ...
       },
       ...
   }

   Por exemplo:

   {
     "dependencies": {
       "global": {
         "tables": ["incident", "problem"],
         "roles": ["admin"],
         "sys_script_client": ["fa776f6d97700100f309124eda2975bc"]
       },
       "x_custom": {
         "tables": ["custom_table"],
         "sys_security_acl": "*",
       }
     }
   }

3. Salve as mudanças.
4. No diretório da aplicação, abra uma janela de terminal integrada.
5. Baixar dependências da aplicação com dependências comando.

   now-sdk dependencies --auth <alias> --fluent-only

   Nota:

   Se você quiser baixar dependências de script também, exclua o. --fluent-only parâmetro.

   . dependências o comando baixa as dependências especificadas em now.config.json E gera definições de typescript para eles no /servicenow/fluent diretório com .d.now.ts extensão do arquivo. Ao criar a aplicação, esses arquivos não são compilados como arquivos de código-fonte.

O que Fazer Depois

Você pode referenciar dependências em ServiceNow Fluentarquivos que usam o. "escopo"/"categoria" formato de importação de subcaminho. Por exemplo:

// Import roles from global scope
import { role as globalRole } from '#now:global/security'

// Import roles from custom app scope  
import { role as xExampleAppRole } from '#now:x_example_app/security'

// Use in ACLs, flows, etc.
Acl({
    $id: Now.ID['my_acl'],
    type: 'record',
    table: 'incident',
    operation: 'read',
    roles: [globalRole.admin, xExampleAppRole.xExampleAppCool],
})

Da sua aplicação pacote.json o arquivo deve incluir o seguinte importações para fazer isso:

{
  "imports": {
    "#now:*": "./@types/servicenow/fluent/*/index.js"
  }
}

Download e. dependências de script

Download de definições de typescript para e. Dependências de script para obter suporte e validação do IntelliSense para APIs Glide e inclusões de script.

Antes de Iniciar

Adicione uma aplicação ao seu sistema local com ServiceNow SDK. Para obter mais informações, consulte Adicionando aplicações com ServiceNow SDK.

Função necessária: administrador

Por Que e Quando Desempenhar Esta Tarefa

Este procedimento usa o. ServiceNow SDKInterface de linha de comando (CLI). Em uma ferramenta de linha de comando, insira now-sdk --help para obter informações sobre os comandos disponíveis e opções globais. Para obter informações adicionais sobre um comando e seus parâmetros, insira o comando e. --help ou -h . Por exemplo, now-sdk auth --help . Para obter mais informações sobre a CLI, consulte ServiceNow SDK CLI.

Procedimento

1. Em Visual Studio Code, abra o diretório da aplicação com escopo.
2. No diretório da aplicação, abra uma janela de terminal integrada.
3. Baixar dependências para scripts na aplicação com dependências comando.

   now-sdk dependencies --auth <alias> --type-defs-only

   Nota:

   Se você quiser baixar dependências da aplicação também, exclua o. --type-defs-only parâmetro.

   . dependências O comando baixa as definições de tipo para todas as APIs Glide e verifica os módulos e scripts em sua aplicação e cria definições de tipo para as inclusões de script que eles usam. As definições de tipo são adicionadas ao /servicenow diretório. Para adicionar outras definições de tipo, você pode criá-las manualmente. Para obter mais informações, consulte Adicione definições de tipo para APIs.

4. Em src/fluente diretório, crie um tsconfig.server.json arquivo para scripts do lado do servidor.
   Em incluir Objeto, inclua as definições de tipo que você baixou para APIs Glide do lado do servidor ( glide.server.d.ts e inclusões de script ( script-includes.server.d.ts ).

   {
     "compilerOptions": {
       "lib": [
         "ES2021"
       ],
       "noEmit": true,
       "checkJs": false,
       "allowJs": true,
       "noEmitHelpers": true,
       "esModuleInterop": false,
       "module": "None",
       "types": []
     },
     "include": [
       "./**/*.server.js",
       "../../@types/servicenow/*.server.d.ts",
     ]
   }

5. Em src/fluente diretório, crie um tsconfig.client.json arquivo para scripts do lado do cliente.
   Em incluir Objeto, inclua as definições de tipo que você baixou para APIs Glide do lado do cliente ( glide.client.d.ts ).

   {
     "compilerOptions": {
       "target": "ES6",
       "lib": [
         "DOM",
         "ES6"
       ],
       "checkJs": false,
       "allowJs": true,
       "noEmit": true,
       "noEmitHelpers": true,
       "esModuleInterop": false,
       "module": "None",
       "types": []
     },
     "include": [
       "./**/*.client.js",
       "../../@types/servicenow/*.client.d.ts",
     ]
   }

6. Em src/fluente diretório, crie um tsconfig.json arquivo.
   Nota:

   Isso tsconfig.json o arquivo é separado de um tsconfig.json Arquivo usado para aplicações que usam typescript para criar módulos JavaScript.

   Em referências objeto, adicione os caminhos ao tsconfig.server.json e. tsconfig.client.json arquivos.

   {
     "files": [],
     "references": [
       {
         "path": "./tsconfig.server.json"
       },
       {
         "path": "./tsconfig.client.json"
       }
     ]
   }

7. Salve as mudanças.

Resultado

Com esta configuração, você pode usar o. .server.js extensão de arquivo para scripts do lado do servidor e. .client.js extensão de arquivo para scripts do lado do cliente e obtenha suporte de autodigitação durante o desenvolvimento.