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

package/dist/schema-types/base.d.ts

@@ -0,0 +1,163 @@
+import { ArcadeApiConstant, SchemaApiFunction } from '.';
+import { BundleType, ProfileType, SchemaValueType } from './common';
+import { SqlApiFunction } from './sql';
+import { ArcadeApiFunction } from './arcade';
+/**
+ * Definition for a schema category
+ */
+export interface SchemaCategory {
+    title: string;
+    description: string[] | string;
+    page: string;
+    hideSummaryList?: boolean;
+}
+export interface GenericSchemaItemBase<Bundle extends BundleType, Profile extends ProfileType> {
+    /**
+     * The name of the function or constant. Must start with a capital letter.
+     * @pattern ^[A-Z]+[a-zA-Z0-9.]*$
+     */
+    name: string;
+    /**
+     * A nice description for the constant or function. It can leverage Github Flavored Markdown formatting.
+     */
+    description: string[] | string;
+    /**
+     * Version string. Format x.y.
+     * @pattern ^1\.\d+$
+     */
+    sinceVersion?: string;
+    /**
+     * Indicates if the item should not be documented.
+     */
+    disableDocumentation?: boolean;
+    /**
+     * The profiles the constant or the function belongs to.
+     */
+    profiles?: Profile[];
+    /**
+     * The bundle the constant or the function belongs to.
+     */
+    bundle: Bundle;
+    /**
+     * The relative path to an image to illustate the constant or the function.
+     */
+    image?: string;
+    /**
+     * The code that will be injected in the classic editor. Must start with a capital letter and match the name of the funtion or constant.
+     * @pattern ^[A-Z]+.*$
+     */
+    snippet: string;
+    /**
+     * The collection of examples
+     */
+    examples?: SchemaExample[];
+    /**
+     * A collection of links to resources
+     */
+    resourceLinks?: SchemaResourceLink[];
+}
+/**
+ * Describes an Api Constant
+ */
+export interface BaseSchemaApiConstant<Bundle extends BundleType = BundleType, Profile extends ProfileType = ProfileType> extends GenericSchemaItemBase<Bundle, Profile> {
+    /**
+     * For constant, the property is mandatory and always true
+     */
+    isConstant: true;
+}
+export type SchemaReturnValue<ValueType extends SchemaValueType = SchemaValueType> = SchemaReturnDefinition<ValueType> | ValueType | ValueType[];
+/**
+ * Describes an Api Function.
+ */
+export interface BaseSchemaApiFunction<Bundle extends BundleType, Profile extends ProfileType, ValueType extends SchemaValueType> extends GenericSchemaItemBase<Bundle, Profile> {
+    /**
+     * For function this property is optional and always false.
+     */
+    isConstant?: boolean;
+    /**
+     * The set of function parameters.
+     */
+    parameters?: SchemaProperty<ValueType>[];
+    /**
+     * The type of data returned by the function.
+     */
+    returnValue?: SchemaReturnValue<ValueType>;
+}
+/**
+ * Describes the properties for the type Property
+ */
+export interface SchemaProperty<ValueType extends SchemaValueType = SchemaValueType> {
+    /**
+     * The name of the property.
+     * @pattern ^([a-z]+[a-zA-Z0-9_]*|\[.*\])$
+     */
+    name: string;
+    /**
+     * The data type of the property value. If the property supports more than one type then use an array.
+     */
+    type: ValueType | ValueType[];
+    /**
+     * The description for the property.
+     */
+    description: string[] | string;
+    /**
+     * Indicates if the property is optional.
+     */
+    optional?: boolean;
+    /**
+     * The properties if the type is Dictionary.
+     */
+    properties?: SchemaProperty<ValueType>[];
+}
+/**
+ * Describes the type fo data returned by a function.
+ */
+export interface SchemaReturnDefinition<T extends SchemaValueType = SchemaValueType> {
+    /**
+     * The data type of the value returned.
+     */
+    type: T;
+    /**
+     * A description for for the value returned.
+     */
+    description?: string[] | string;
+    /**
+     * The properties if the type returned is a Dictionary
+     */
+    properties?: SchemaProperty<T>[];
+}
+/**
+ * Describes an example
+ */
+export interface SchemaExample {
+    /**
+     * A description for the example.
+     */
+    description?: string[] | string;
+    /**
+     * Either a single line string or an array of strings.
+     */
+    code: string[] | string;
+}
+/**
+ * Describes a link to additional resources
+ */
+export interface SchemaResourceLink {
+    /**
+     * The text used to describe the resource link.
+     */
+    linkText: string;
+    /**
+     * The url to the resource.
+     */
+    url: string;
+}
+/**
+ * Definition for simple item
+ */
+export type SingularApiItem = ArcadeApiConstant | ArcadeApiFunction | SqlApiFunction;
+/**
+ * Definition for a constant or a function.
+ * An Api Item can be either a constant, a function, or an array of functions
+ */
+export type BaseSchemaApiItem<LanguageApiFunction extends SchemaApiFunction, LanguageApiConstant extends BaseSchemaApiConstant | undefined = undefined> = LanguageApiFunction | LanguageApiFunction[] | (LanguageApiConstant extends undefined ? never : LanguageApiConstant);

package/dist/schema-types/common.d.ts

@@ -0,0 +1,14 @@
+import { ArcadeBundleType, ArcadeProfileType, ArcadeValueType } from './arcade';
+import { SqlBundleType, SqlProfileType, SqlValueType } from './sql';
+/**
+ * Union of bundle types that can be used in any sdk schema
+ */
+export type BundleType = ArcadeBundleType | SqlBundleType;
+/**
+ * Union of profile types that can be used in any sdk schema
+ */
+export type ProfileType = ArcadeProfileType | SqlProfileType;
+/**
+ * The collection of supported return types.
+ */
+export type SchemaValueType = ArcadeValueType | SqlValueType;

package/dist/schema-types/index.d.ts

@@ -0,0 +1,21 @@
+import { ArcadeApiFunction, ArcadeApiItem, ArcadeSchemaItemBase } from './arcade';
+import { SqlApiFunction, SqlApiItem, SqlSchemaItemBase } from './sql';
+/**
+ *
+ */
+export type { ArcadeApiItem, ArcadeApiConstant } from './arcade';
+export type { SqlApiItem } from './sql';
+/**
+ * Union of API items that can be used in any sdk schema
+ */
+export type SchemaApiItem = ArcadeApiItem | SqlApiItem;
+/**
+ * Union of API functions that can be used in any sdk schema
+ */
+export type SchemaApiFunction = ArcadeApiFunction | SqlApiFunction;
+/**
+ * Union of schema items that can be used in any sdk schema
+ */
+export type SchemaItemBase = ArcadeSchemaItemBase | SqlSchemaItemBase;
+export type * from './base';
+export type * from './common';

package/dist/schema-types/sql.d.ts

@@ -0,0 +1,55 @@
+import { BaseSchemaApiFunction, BaseSchemaApiItem, GenericSchemaItemBase } from './base';
+/**
+ * Supported function bundles
+ */
+export type SqlBundleType = "date" | "numeric" | "string";
+/**
+ * Supported sql profile names
+ */
+export type SqlProfileType = "Field Calculation";
+export type SqlValueType = "Datetime" | "Number" | "String";
+/**
+ * Narrowed schema item type for sql
+ */
+export type SqlSchemaItemBase = GenericSchemaItemBase<SqlBundleType, SqlProfileType>;
+/**
+ * Narrowed api function type for sql
+ */
+export type SqlApiFunction = BaseSchemaApiFunction<SqlBundleType, SqlProfileType, SqlValueType> & {
+    /**
+     * The name of the function.
+     */
+    name: string;
+    /**
+     * SQL functions may be "special registers" that are not called like regular functions.
+     * For example, CURRENT_DATE is a special register.
+     * These functions are not called with parentheses or arguments.
+     */
+    isSpecialRegister?: boolean;
+    /**
+     * The set of keywords that are used in the function.
+     */
+    keywords?: SchemaKeyword[];
+};
+/**
+ * Narrowed api item type for sql. Sql does not have constants so all sql items are "functions".
+ */
+export type SqlApiItem = BaseSchemaApiItem<SqlApiFunction>;
+/**
+ * Describes a keyword used in a function
+ */
+interface SchemaKeyword {
+    /**
+     * The name of the keyword.
+     */
+    name: string;
+    /**
+     * The description for the keyword.
+     */
+    description: string;
+    /**
+     * (optional) position of the keyword in the function signature, default is to interlace with parameters
+     */
+    position?: number;
+}
+export {};