@arcgis/languages-sdk-spec 4.33.0-next.15 → 4.33.0-next.151

package/dist/scripting/utilities.d.ts

@@ -0,0 +1,58 @@
+import { ArcadeApiConstant, SchemaApiFunction, SchemaApiItem, SchemaCategory, SchemaExample, SchemaProperty, SchemaResourceLink, SchemaReturnDefinition, SchemaReturnValue, SingularApiItem } from '../schema-types';
+import { SqlApiFunction } from '../schema-types/sql';
+import { SdkDictionaryVariable, SdkVariable } from '../profile-types';
+export type Paths = {
+    relativePath: string;
+    absolutePath: string;
+};
+export declare function isSchemaDictionaryVariable(variable: SdkVariable): variable is SdkDictionaryVariable;
+export declare function getDirectoryNames(path: string): Promise<string[]>;
+export declare function getFileNames(path: string): Promise<string[]>;
+/**
+ * Structure used when reading the API Files
+ */
+export interface ApiDatabase {
+    categories: ApiCategories;
+    resources: ApiResources;
+}
+export type ApiCategories = Record<string, {
+    definition: SchemaCategory;
+    items: Map<string, SchemaApiItem>;
+}>;
+export type ApiResources = Record<string, string>;
+export declare const DefaultApiResources: ApiResources;
+export declare function isSchemaFunction(item: SchemaApiItem): item is SchemaApiFunction;
+export declare function isSchemaConstant(item: SchemaApiItem): item is ArcadeApiConstant;
+export declare function isSchemaReturnDefinition(item: SchemaReturnValue): item is SchemaReturnDefinition;
+export declare function loadApiDatabase(languageFileName: string): Promise<ApiDatabase>;
+export declare const toLocalConfig: {
+    minimumIntegerDigits: number;
+    useGrouping: boolean;
+};
+export declare function convertStringArrayToObject(array: string[] | string | undefined): Record<string, string>;
+export declare function convertObjectToArray<T>(obj: Record<string, T> | undefined): T[] | undefined;
+export declare function headingPattern(level: number): string;
+export declare function isFunction(apiItem: SingularApiItem): apiItem is SchemaApiFunction;
+export declare function assembleMarkdownString(value: string[] | string | undefined): string;
+export declare function apiItemName(item: SchemaApiItem): string;
+export declare function generateSinceVersionSection(resources: ApiResources, apiItem: SingularApiItem, paths: Paths, relative?: boolean): string[];
+export declare function generateSignature(apiItem: SingularApiItem, paths: Paths, { relative, typeLink, needsHtmlEntity }?: {
+    relative?: boolean | undefined;
+    typeLink?: boolean | undefined;
+    needsHtmlEntity?: boolean | undefined;
+}): string;
+export declare function generateTypeLink(values: string[] | string, paths: Paths, relative?: boolean): string;
+export declare function generateParametersSection(resources: ApiResources, parameters: SchemaProperty[] | undefined, paths: Paths, relative?: boolean, useTypeLinks?: boolean): string[];
+export declare function generateReturnSection(resources: ApiResources, returnDefinition: SchemaReturnValue, paths: Paths, relative?: boolean, useTypeLinks?: boolean): string[];
+export declare function generateExamplesSection(resources: ApiResources, examples: SchemaExample[] | undefined, headingPattern: "**" | "#####", language: string): string[];
+export declare function generateAdditionalResourcesSection(resources: ApiResources, resourceLinks: SchemaResourceLink[] | undefined, headingPattern: "**" | "####"): string[];
+export declare function fixUrl(description: string, paths: Paths, relative?: boolean): string;
+/**
+ * Interlaces two arrays and joins them into a string with spaces.
+ * @param {string[]} array1 - The first array.
+ * @param {string[]} array2 - The second array.
+ * @param {number[]} [positions] - Optional positions for the second array elements.
+ * @returns {string[]} - The interlaced array.
+ */
+export declare function interlaceArrays(array1: string[], array2: string[], positions?: number[]): string;
+export declare function isSqlApiFunction(apiItem: SchemaApiItem): apiItem is SqlApiFunction;

package/dist/t9n-types.d.ts

@@ -0,0 +1,28 @@
+export interface T9NApiRoot {
+    resources: Record<string, string>;
+    categories: T9NCategories;
+}
+export type T9NCategories = Record<string, T9NCategory>;
+export interface T9NCategory {
+    title: string;
+    description?: Record<string, string>;
+    items: T9NApiItems;
+}
+export type T9NResource = Record<string, string>;
+export type T9NApiItems = Record<string, Record<string, T9NApiItem> | T9NApiItem>;
+export interface T9NProperty {
+    description?: Record<string, string>;
+    properties?: Record<string, T9NProperty>;
+}
+export interface T9NApiItem {
+    description: Record<string, string>;
+    examples?: Record<string, Record<string, string>>;
+    parameters?: Record<string, T9NProperty>;
+    returnValue?: T9NProperty;
+}
+export type T9NProfiles = Record<string, T9NProfileVariables>;
+export type T9NProfileVariables = Record<string, T9NProfileVariable>;
+export interface T9NProfileVariable {
+    description?: string;
+    properties?: T9NProfileVariables;
+}

package/dist/types.d.ts

@@ -0,0 +1,79 @@
+import { BundleType } from './schema-types';
+import { CompletionItem } from 'vscode-languageserver-types';
+import { ProfileId, SdkPredefinedProfile, SdkVariable, SdkValueVariable, SdkDictionaryVariable, SdkVariableType } from './profile-types';
+/**
+ * Represents an api category and its items
+ */
+interface SdkCategory {
+    /**
+     * The unique ID for the category
+     */
+    id: string;
+    /**
+     * The title for the category
+     */
+    title: string;
+    /**
+     * The collection of api items for the category
+     */
+    items: SdkItem[];
+}
+interface SdkItemBase {
+    /**
+     * The name of the function or constant.
+     */
+    name: string;
+    /**
+     * The version string when the api item was introduced. If undefined then it was from the origin.
+     */
+    sinceVersion?: string;
+    /**
+     * The api bundle this item belongs to.
+     */
+    bundle: BundleType;
+    /**
+     * Markdown description of the item.
+     */
+    description: string;
+    /**
+     * Markdown containing examples.
+     */
+    examples: string;
+    /**
+     * Link for additional information about the item.
+     */
+    link?: string;
+    /**
+     * Completion item directly leveraged by the editor.
+     */
+    completion: CompletionItem;
+    /**
+     * Indicates if the documentation for this item should be disabled.
+     */
+    disableDocumentation?: boolean;
+}
+/**
+ * Represents a constant in the arcade api.
+ */
+interface SdkConstant extends SdkItemBase {
+    type: "constant";
+}
+/**
+ * Represents a function in the arcade api
+ */
+interface SdkFunction extends SdkItemBase {
+    type: "function";
+    /**
+     * Information leveraged by the editor to validate function call.
+     * Indicates the minimum number of expected parameters and the maximum number of parameters expected.
+     */
+    parametersInfo: {
+        min: number;
+        max: number;
+    };
+}
+/**
+ * Represents an item in the arcade api.
+ */
+type SdkItem = SdkConstant | SdkFunction | SdkFunction[];
+export type { CompletionItem, ProfileId, BundleType, SdkPredefinedProfile, SdkVariable, SdkValueVariable, SdkDictionaryVariable, SdkVariableType, SdkCategory, SdkItem, SdkItemBase, SdkConstant, SdkFunction, };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/languages-sdk-spec",
-  "version": "4.33.0-next.15",
+  "version": "4.33.0-next.151",
   "description": "ArcGIS languages types and schemas for design a language sdk",
   "homepage": "https://developers.arcgis.com/javascript/latest/",
   "type": "module",
@@ -9,6 +9,7 @@
   "types": "dist/index.d.ts",
   "exports": {
     ".": "./dist/index.js",
+    "./scripting": "./dist/scripting/index.js",
     "./dist/schemas/*.schema.json": "./dist/schemas/*.schema.json"
   },
   "files": [
@@ -16,7 +17,7 @@
   ],
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "tslib": "^2.7.0",
+    "tslib": "^2.8.1",
     "vscode-languageserver-types": "^3.17.5"
   }
 }