@aidc-toolkit/app-extension 1.0.45 → 1.0.46

package/dist/generator/index.d.cts

@@ -0,0 +1,126 @@
+import { Promisable } from '@aidc-toolkit/core';
+import { Logger } from 'tslog';
+import { C as ClassDescriptor, e as MethodDescriptor } from '../descriptor-FJHoLlYK.cjs';
+
+/**
+ * Localization.
+ */
+interface Localization {
+    /**
+     * Name.
+     */
+    readonly name: string;
+    /**
+     * Description.
+     */
+    readonly description: string;
+}
+/**
+ * Function localization.
+ */
+interface FunctionLocalization extends Localization {
+    /**
+     * Namespace function name.
+     */
+    readonly namespaceFunctionName: string;
+    /**
+     * Documentation URL.
+     */
+    readonly documentationURL: string;
+    /**
+     * Parameters map.
+     */
+    readonly parametersMap: ReadonlyMap<string, Localization>;
+}
+/**
+ * Abstract generator.
+ */
+declare abstract class Generator {
+    #private;
+    /**
+     * Constructor.
+     *
+     * @param version
+     * Package version.
+     *
+     * @param includeLocalizations
+     * Include localizations if true.
+     */
+    constructor(version: string, includeLocalizations?: boolean);
+    /**
+     * Get the logger.
+     */
+    get logger(): Logger<object>;
+    /**
+     * Get the package version.
+     */
+    get version(): string;
+    /**
+     * Get the locales.
+     */
+    protected get locales(): readonly string[];
+    /**
+     * Get the default locale.
+     */
+    protected get defaultLocale(): string;
+    /**
+     * Initialize the generation of the output.
+     */
+    protected abstract initialize(): Promisable<void>;
+    /**
+     * Create a namespace.
+     *
+     * @param namespace
+     * Namespace.
+     */
+    protected abstract createNamespace(namespace: string | undefined): void;
+    /**
+     * Create a category.
+     *
+     * @param namespace
+     * Namespace.
+     *
+     * @param category
+     * Category.
+     *
+     * @param categoryLocalizationsMap
+     * Category localizations map.
+     */
+    protected abstract createCategory(namespace: string | undefined, category: string, categoryLocalizationsMap: ReadonlyMap<string, string>): void;
+    /**
+     * Create a proxy object for a class.
+     *
+     * @param objectName
+     * Object name, derived from namespace and class name.
+     *
+     * @param classDescriptor
+     * Class descriptor.
+     */
+    protected abstract createProxyObject(objectName: string, classDescriptor: ClassDescriptor): void;
+    /**
+     * Create a proxy function for a class and method.
+     *
+     * @param classDescriptor
+     * Class descriptor.
+     *
+     * @param methodDescriptor
+     * Method descriptor.
+     *
+     * @param functionLocalizationsMap
+     * Function localizations map.
+     */
+    protected abstract createProxyFunction(classDescriptor: ClassDescriptor, methodDescriptor: MethodDescriptor, functionLocalizationsMap: ReadonlyMap<string, FunctionLocalization>): void;
+    /**
+     * Finalize the generation of the output.
+     *
+     * @param success
+     * True if successful.
+     */
+    protected abstract finalize(success: boolean): Promisable<void>;
+    /**
+     * Generate by processing individual imports.
+     */
+    generate(): Promise<void>;
+}
+
+export { type FunctionLocalization, Generator, type Localization };

package/dist/generator/index.d.ts

@@ -0,0 +1,126 @@
+import { Promisable } from '@aidc-toolkit/core';
+import { Logger } from 'tslog';
+import { C as ClassDescriptor, e as MethodDescriptor } from '../descriptor-FJHoLlYK.js';
+
+/**
+ * Localization.
+ */
+interface Localization {
+    /**
+     * Name.
+     */
+    readonly name: string;
+    /**
+     * Description.
+     */
+    readonly description: string;
+}
+/**
+ * Function localization.
+ */
+interface FunctionLocalization extends Localization {
+    /**
+     * Namespace function name.
+     */
+    readonly namespaceFunctionName: string;
+    /**
+     * Documentation URL.
+     */
+    readonly documentationURL: string;
+    /**
+     * Parameters map.
+     */
+    readonly parametersMap: ReadonlyMap<string, Localization>;
+}
+/**
+ * Abstract generator.
+ */
+declare abstract class Generator {
+    #private;
+    /**
+     * Constructor.
+     *
+     * @param version
+     * Package version.
+     *
+     * @param includeLocalizations
+     * Include localizations if true.
+     */
+    constructor(version: string, includeLocalizations?: boolean);
+    /**
+     * Get the logger.
+     */
+    get logger(): Logger<object>;
+    /**
+     * Get the package version.
+     */
+    get version(): string;
+    /**
+     * Get the locales.
+     */
+    protected get locales(): readonly string[];
+    /**
+     * Get the default locale.
+     */
+    protected get defaultLocale(): string;
+    /**
+     * Initialize the generation of the output.
+     */
+    protected abstract initialize(): Promisable<void>;
+    /**
+     * Create a namespace.
+     *
+     * @param namespace
+     * Namespace.
+     */
+    protected abstract createNamespace(namespace: string | undefined): void;
+    /**
+     * Create a category.
+     *
+     * @param namespace
+     * Namespace.
+     *
+     * @param category
+     * Category.
+     *
+     * @param categoryLocalizationsMap
+     * Category localizations map.
+     */
+    protected abstract createCategory(namespace: string | undefined, category: string, categoryLocalizationsMap: ReadonlyMap<string, string>): void;
+    /**
+     * Create a proxy object for a class.
+     *
+     * @param objectName
+     * Object name, derived from namespace and class name.
+     *
+     * @param classDescriptor
+     * Class descriptor.
+     */
+    protected abstract createProxyObject(objectName: string, classDescriptor: ClassDescriptor): void;
+    /**
+     * Create a proxy function for a class and method.
+     *
+     * @param classDescriptor
+     * Class descriptor.
+     *
+     * @param methodDescriptor
+     * Method descriptor.
+     *
+     * @param functionLocalizationsMap
+     * Function localizations map.
+     */
+    protected abstract createProxyFunction(classDescriptor: ClassDescriptor, methodDescriptor: MethodDescriptor, functionLocalizationsMap: ReadonlyMap<string, FunctionLocalization>): void;
+    /**
+     * Finalize the generation of the output.
+     *
+     * @param success
+     * True if successful.
+     */
+    protected abstract finalize(success: boolean): Promisable<void>;
+    /**
+     * Generate by processing individual imports.
+     */
+    generate(): Promise<void>;
+}
+
+export { type FunctionLocalization, Generator, type Localization };

package/dist/generator/index.js

@@ -0,0 +1,17 @@
+import{b as $,c as d,d as b,h as z,i as D,r as M,s as P}from"../chunk-FAD3UX6B.js";import{ALPHA_URL as O,getLogger as j,I18nEnvironments as E,websiteURL as U}from"@aidc-toolkit/core";function H(...p){}H(D,M,P);var w=class p{static#o="app-extension/";#n=j();#t;#e;#a;constructor(s,r=!0){this.#t=s,this.#e=r?Object.keys($):[],this.#a=this.#e[0]??""}get logger(){return this.#n}get version(){return this.#t}get locales(){return this.#e}get defaultLocale(){return this.#a}static#s(s,r,i){let e={lng:s,returnObjects:!0};return i(s,d.t(r,e))}async generate(){let s=!1;await b(E.CLI);let r=U(this.version,!0,await O);await this.initialize();let i=new Map;for(let e of z.classDescriptors){let l=e.namespace,c=e.category,o=i.get(l);o===void 0&&(o=new Map,i.set(l,o));let t=o.get(c);t===void 0&&(t=[],o.set(c,t)),t.push(e)}try{for(let[e,l]of i){let c=e===void 0?"":`${e}.`,o=e===void 0?"":`${e}/`;this.createNamespace(e);for(let[t,C]of l){let N=`${c}${t}`,v=`Categories.${t}`,f=`Categories.${N}`,R=new Map(this.locales.map(n=>{let a={lng:n};return[n,d.t(d.exists(f,a)?f:v,a)]}));this.createCategory(e,t,R);let h=new Set;for(let n of C){let a=n.namespaceClassName;if(h.has(a))throw new Error(`Duplicate class ${a}`);h.add(a);let m=/^(?<namespaceFirstWord>[A-Z]+[0-9]*|[A-Z][^A-Z.]*)(?<namespaceRemaining>[A-Z][^.]*|)\.?(?<className>[A-Z].*|)$/u.exec(a)?.groups;if(m===void 0)throw new Error(`${a} is not a valid namespace-qualified class name`);this.createProxyObject(`${m.namespaceFirstWord.toLowerCase()}${m.namespaceRemaining}${m.className}`,n);for(let g of n.methodDescriptors){let A=new Map(this.locales.map(L=>[L,p.#s(L,`Functions.${g.namespaceFunctionName}`,(u,y)=>({...y,namespaceFunctionName:`${c}${y.name}`,documentationURL:`${r}/${u===this.defaultLocale?"":`${u}/`}${p.#o}${o}${y.name}.html`,parametersMap:new Map(g.parameterDescriptors.map(x=>[x.name,p.#s(u,`Parameters.${x.name}`,(T,F)=>F)]))}))]));this.createProxyFunction(n,g,A)}}}}s=!0}finally{await this.finalize(s)}}};export{w as Generator};
+/*!
+ * Copyright © 2024-2026 Dolphin Data Development Ltd. and AIDC Toolkit
+ * contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */

package/dist/index.d.cts

@@ -1,6 +1,7 @@
 import { I18nEnvironment, MemoryTransport, Promisable, AppDataStorage, Hyperlink, Nullishable } from '@aidc-toolkit/core';
 import { Resource, i18n } from 'i18next';
 import { Logger } from 'tslog';
+export { C as ClassDescriptor, E as ExtendsParameterDescriptor, e as MethodDescriptor, M as Multiplicities, d as Multiplicity, c as MultiplicityKey, P as ParameterDescriptor, R as ReplacementParameterDescriptor, b as Type, a as TypeKey, T as Types } from './descriptor-FJHoLlYK.cjs';
 import { StringValidation, StringValidator, CharacterSetValidator, Exclusion, CharacterSetCreator } from '@aidc-toolkit/utility';
 import { NumericIdentifierType, IdentifierType, IdentifierTypeValidator, GTINType, NonGTINNumericIdentifierType, NonSerializableNumericIdentifierType, SerializableNumericIdentifierType, NonNumericIdentifierType, NonNumericIdentifierValidation, GTINLevel, PrefixType, NumericIdentifierCreator, IdentifierValidation, IdentifierCreator, PrefixManager, NumericIdentifierValidation, NonGTINNumericIdentifierCreator, SerializableNumericIdentifierCreator, NonNumericIdentifierCreator, GTINCreator } from '@aidc-toolkit/gs1';
 
@@ -1202,202 +1203,6 @@ declare abstract class LibProxy<ThrowError extends boolean, TError extends Error
     protected iterableResult<TResult>(iterableCallback: () => Iterable<SingletonResult<TResult, ThrowError, TError>>): MatrixResult<TResult, ThrowError, TError>;
 }
 
-/**
- * Core descriptor.
- */
-interface Descriptor {
-    /**
-     * Name.
-     */
-    readonly name: string;
-}
-/**
- * Types supported by proxy methods.
- */
-declare const Types: {
-    /**
-     * String.
-     */
-    readonly String: 0;
-    /**
-     * Number or enumeration.
-     */
-    readonly Number: 1;
-    /**
-     * Boolean.
-     */
-    readonly Boolean: 2;
-    /**
-     * Any.
-     */
-    readonly Any: 3;
-};
-/**
- * Type key.
- */
-type TypeKey = keyof typeof Types;
-/**
- * Type.
- */
-type Type = typeof Types[TypeKey];
-/**
- * Multiplicities supported by proxy methods.
- */
-declare const Multiplicities: {
-    /**
-     * Parameter or return value is a singleton.
-     */
-    readonly Singleton: 0;
-    /**
-     * Parameter or return value is a singleton or an array.
-     */
-    readonly Array: 1;
-    /**
-     * Parameter or return value is a singleton, an array, or a matrix.
-     */
-    readonly Matrix: 2;
-    /**
-     * Parameter value is a singleton or array but is treated as a singleton internally and doesn't drive multiplicity
-     * of the return value. Return value is an array for use as a singleton array parameter.
-     */
-    readonly SingletonArray: 3;
-};
-/**
- * Multiplicity key.
- */
-type MultiplicityKey = keyof typeof Multiplicities;
-/**
- * Multiplicity.
- */
-type Multiplicity = typeof Multiplicities[MultiplicityKey];
-/**
- * Type descriptor.
- */
-interface TypeDescriptor extends Descriptor {
-    /**
-     * Type.
-     */
-    readonly type: Type;
-    /**
-     * Multiplicity.
-     */
-    readonly multiplicity: Multiplicity;
-}
-/**
- * Parameter descriptor.
- */
-interface ParameterDescriptor extends TypeDescriptor {
-    /**
-     * True if required.
-     */
-    readonly isRequired: boolean;
-}
-/**
- * Extends parameter descriptor.
- */
-interface ExtendsParameterDescriptor extends Partial<ParameterDescriptor> {
-    /**
-     * Parameter descriptor that this one extends.
-     */
-    readonly extendsDescriptor: ParameterDescriptor | ExtendsParameterDescriptor;
-    /**
-     * Sort order within extended parameter descriptor.
-     */
-    readonly sortOrder?: number;
-}
-/**
- * Replacement parameter descriptor.
- */
-interface ReplacementParameterDescriptor {
-    /**
-     * Name to replace.
-     */
-    readonly name: string;
-    /**
-     * Replacement parameter descriptor.
-     */
-    readonly replacement: ParameterDescriptor;
-}
-/**
- * Method descriptor.
- */
-interface MethodDescriptor extends TypeDescriptor {
-    /**
-     * If true, method is asynchronous.
-     */
-    readonly isAsync?: true;
-    /**
-     * If true, function is hidden from user interface.
-     */
-    readonly isHidden?: true;
-    /**
-     * If true, application-specific invocation context is required.
-     */
-    readonly requiresContext?: true;
-    /**
-     * If true, function is volatile and should be reevaluated regularly.
-     */
-    readonly isVolatile?: true;
-    /**
-     * If true, function opens a stream that updates asynchronously.
-     */
-    readonly isStream?: true;
-    /**
-     * Number of characters to capitalize at the start of the method name for title case; defaults to 1.
-     */
-    readonly titleCaseStart?: number;
-    /**
-     * If true, method infix is ignored.
-     */
-    readonly ignoreInfix?: true;
-    /**
-     * String before which method infix appears. If undefined, infix is appended to the method name. Ignored if
-     * `ignoreInfix` is true.
-     */
-    readonly infixBefore?: string;
-    /**
-     * Parameter descriptors.
-     */
-    readonly parameterDescriptors: readonly ParameterDescriptor[];
-    /**
-     * Function name with optional infix.
-     */
-    readonly functionName: string;
-    /**
-     * Function name in optional namespace with optional infix.
-     */
-    readonly namespaceFunctionName: string;
-}
-/**
- * Class descriptor.
- */
-interface ClassDescriptor extends Descriptor {
-    /**
-     * Class namespace. If not provided, class is at the top level.
-     */
-    readonly namespace?: string | undefined;
-    /**
-     * Category.
-     */
-    readonly category: string;
-    /**
-     * Method infix. If undefined, method name is generated verbatim.
-     */
-    readonly methodInfix?: string | undefined;
-    /**
-     * Replacement parameter descriptors  for class hierarchies where parameter types can narrow
-     */
-    readonly replacementParameterDescriptors?: ReplacementParameterDescriptor[];
-    /**
-     * Class name in optional namespace.
-     */
-    readonly namespaceClassName: string;
-    /**
-     * Method descriptors.
-     */
-    readonly methodDescriptors: readonly MethodDescriptor[];
-}
-
 /**
  * Application utilities.
  *
@@ -1749,4 +1554,4 @@ declare namespace index {
   export { index_AI39Proxy as AI39Proxy, index_AI64Proxy as AI64Proxy, index_AI82Proxy as AI82Proxy, index_CPIDCreatorProxy as CPIDCreatorProxy, index_CPIDValidatorProxy as CPIDValidatorProxy, index_CheckProxy as CheckProxy, index_GCNCreatorProxy as GCNCreatorProxy, index_GCNValidatorProxy as GCNValidatorProxy, index_GCPLengthProxy as GCPLengthProxy, index_GDTICreatorProxy as GDTICreatorProxy, index_GDTIValidatorProxy as GDTIValidatorProxy, index_GIAICreatorProxy as GIAICreatorProxy, index_GIAIValidatorProxy as GIAIValidatorProxy, index_GINCCreatorProxy as GINCCreatorProxy, index_GINCValidatorProxy as GINCValidatorProxy, index_GLNCreatorProxy as GLNCreatorProxy, index_GLNValidatorProxy as GLNValidatorProxy, index_GMNCreatorProxy as GMNCreatorProxy, index_GMNValidatorProxy as GMNValidatorProxy, index_GRAICreatorProxy as GRAICreatorProxy, index_GRAIValidatorProxy as GRAIValidatorProxy, index_GSINCreatorProxy as GSINCreatorProxy, index_GSINValidatorProxy as GSINValidatorProxy, index_GSRNCreatorProxy as GSRNCreatorProxy, index_GSRNValidatorProxy as GSRNValidatorProxy, index_GTIN12ValidatorProxy as GTIN12ValidatorProxy, index_GTIN13ValidatorProxy as GTIN13ValidatorProxy, index_GTIN8ValidatorProxy as GTIN8ValidatorProxy, index_GTINCreatorProxy as GTINCreatorProxy, index_GTINValidatorStaticProxy as GTINValidatorStaticProxy, index_PrefixManagerProxy as PrefixManagerProxy, index_SSCCCreatorProxy as SSCCCreatorProxy, index_SSCCValidatorProxy as SSCCValidatorProxy, index_VariableMeasureProxy as VariableMeasureProxy, index_VerifiedByGS1Proxy as VerifiedByGS1Proxy };
 }
 
-export { type Address, AlphabeticProxy, AlphanumericProxy, AppExtension, type AppExtensionLocaleResources, AppHelperProxy, CharacterSetCreatorProxy, CharacterSetValidatorProxy, type ClassDescriptor, type ErrorExtends, type ExtendsParameterDescriptor, index as GS1, HexadecimalProxy, LibProxy, type Matrix, type MatrixResult, type MethodDescriptor, Multiplicities, type Multiplicity, type MultiplicityKey, NumericProxy, type ParameterDescriptor, type Range, RegExpProxy, type ReplacementParameterDescriptor, type Sheet, type SheetAddress, type SheetRange, type SingletonResult, type StreamingCancelledCallback, type StreamingConsumerCallback, TransformerProxy, type Type, type TypeKey, Types, appExtensionNS, appExtensionResourceBundle, i18nAppExtensionInit, i18nextAppExtension };
+export { type Address, AlphabeticProxy, AlphanumericProxy, AppExtension, type AppExtensionLocaleResources, AppHelperProxy, CharacterSetCreatorProxy, CharacterSetValidatorProxy, type ErrorExtends, index as GS1, HexadecimalProxy, LibProxy, type Matrix, type MatrixResult, NumericProxy, type Range, RegExpProxy, type Sheet, type SheetAddress, type SheetRange, type SingletonResult, type StreamingCancelledCallback, type StreamingConsumerCallback, TransformerProxy, appExtensionNS, appExtensionResourceBundle, i18nAppExtensionInit, i18nextAppExtension };