@skmtc/core 0.0.491 → 0.0.492

package/script/context/GenerateContext.d.ts

@@ -0,0 +1,232 @@
+import type { ImportNameArg } from '../dsl/Import.js';
+import { Definition } from '../dsl/Definition.js';
+import type { OasDocument } from '../oas/document/Document.js';
+import type { OasSchema } from '../oas/schema/Schema.js';
+import type { OasRef } from '../oas/ref/Ref.js';
+import type { ClientGeneratorSettings, ClientSettings } from '../types/Settings.js';
+import type { Method } from '../types/Method.js';
+import type { OperationInsertable, OperationGateway } from '../dsl/operation/OperationInsertable.js';
+import type { OasOperation } from '../oas/operation/Operation.js';
+import type { ModelInsertable } from '../dsl/model/ModelInsertable.js';
+import type { GenerationType, GeneratedValue } from '../types/GeneratedValue.js';
+import { ContentSettings } from '../dsl/ContentSettings.js';
+import type { RefName } from '../types/RefName.js';
+import type * as log from '../deps/jsr.io/@std/log/0.224.8/mod.js';
+import type { GeneratorKey } from '../types/GeneratorKeys.js';
+import type { ResultType } from '../types/Results.js';
+import type { StackTrail } from './StackTrail.js';
+import type { Identifier } from '../dsl/Identifier.js';
+import type { SchemaToValueFn, SchemaType, TypeSystemOutput } from '../types/TypeSystem.js';
+import { Inserted } from '../dsl/Inserted.js';
+import { File } from '../dsl/File.js';
+import type { GeneratorsMap, GeneratorType } from '../types/GeneratorType.js';
+type ConstructorArgs = {
+    oasDocument: OasDocument;
+    settings: ClientSettings | undefined;
+    logger: log.Logger;
+    callback: (generatorKey: GeneratorKey) => void;
+    stackTrail: StackTrail;
+    captureCurrentResult: (result: ResultType) => void;
+    toGeneratorsMap: <EnrichmentType>() => GeneratorsMap<GeneratorType<EnrichmentType>, EnrichmentType>;
+};
+export type PickArgs = {
+    name: string;
+    exportPath: string;
+};
+export type ApplyPackageImportsArgs = {
+    destinationPath: string;
+    exportPath: string;
+};
+export type RegisterArgs = {
+    imports?: Record<string, ImportNameArg[]>;
+    reExports?: Record<string, Identifier[]>;
+    definitions?: (Definition | undefined)[];
+    preview?: {
+        [group: string]: string;
+    };
+    destinationPath: string;
+};
+export type CreateAndRegisterDefinition<Schema extends SchemaType> = {
+    schema: Schema;
+    identifier: Identifier;
+    destinationPath: string;
+    schemaToValueFn: SchemaToValueFn;
+};
+export type DefineAndRegisterArgs<V extends GeneratedValue> = {
+    identifier: Identifier;
+    value: V;
+    destinationPath: string;
+};
+export type GetOperationSettingsArgs = {
+    generatorId: string;
+    path: string;
+    method: Method;
+};
+export type AddRenderDependencyArgs = {
+    generatorId: string;
+    operation: OasOperation;
+    dependencies: string[];
+};
+export type GetModelSettingsArgs = {
+    generatorId: string;
+    refName: RefName;
+};
+export type InsertOperationArgs<V extends GeneratedValue, T extends GenerationType, EnrichmentType> = {
+    insertable: OperationInsertable<V, EnrichmentType>;
+    operation: OasOperation;
+    generation?: T;
+    destinationPath?: string;
+};
+export type InsertModelArgs<V extends GeneratedValue, T extends GenerationType, EnrichmentType> = {
+    insertable: ModelInsertable<V, EnrichmentType>;
+    refName: RefName;
+    generation?: T;
+    destinationPath?: string;
+};
+export type InsertReturn<V extends GeneratedValue, T extends GenerationType> = Inserted<V, T>;
+type ToOperationSettingsArgs<V, EnrichmentType> = {
+    operation: OasOperation;
+    insertable: OperationInsertable<V, EnrichmentType>;
+};
+type BuildModelSettingsArgs<V, EnrichmentType> = {
+    refName: RefName;
+    insertable: ModelInsertable<V, EnrichmentType>;
+};
+type GenerateResult = {
+    files: Map<string, File>;
+    previews: Record<string, Record<string, string>>;
+};
+export declare class GenerateContext {
+    #private;
+    oasDocument: OasDocument;
+    settings: ClientSettings | undefined;
+    logger: log.Logger;
+    callback: (generatorKey: GeneratorKey) => void;
+    captureCurrentResult: (result: ResultType) => void;
+    toGeneratorsMap: <EnrichmentType>() => GeneratorsMap<GeneratorType<EnrichmentType>, EnrichmentType>;
+    constructor({ oasDocument, settings, logger, callback, captureCurrentResult, stackTrail, toGeneratorsMap }: ConstructorArgs);
+    /**
+     * @internal
+     */
+    generate(): GenerateResult;
+    trace<T>(token: string | string[], fn: () => T): T;
+    /**
+     * Converts schema to value using `schemaToValueFn` and creates definition
+     * with the given `identifier` at `destinationPath`.
+     *
+     * If a definition with the same name already exists, it will be returned
+     * instead of creating a new one.
+     *
+     * @experimental
+     *
+     * @param schema - The schema to create the definition for.
+     * @param identifier - The identifier for the definition.
+     * @param destinationPath - The path to the file where the definition will be registered.
+     * @param schemaToValueFn - A function that converts the schema to a value.
+     * @returns The created definition or cached definition if it already exists.
+     */
+    createAndRegisterDefinition<Schema extends SchemaType>({ schema, identifier, destinationPath, schemaToValueFn }: CreateAndRegisterDefinition<Schema>): Definition<TypeSystemOutput<Schema['type']>>;
+    /**
+     * Create and register a definition with the given `identifier` at `destinationPath`.
+     *
+     * @experimental
+     */
+    defineAndRegister<V extends GeneratedValue>({ identifier, value, destinationPath }: DefineAndRegisterArgs<V>): Definition<V>;
+    /**
+     * Insert supplied `imports` and `definitions` into file at `destinationPath`.
+     *
+     * If an import from a specified module already exists in the file, the
+     * import names are appended to the existing import.
+     *
+     * Definitions will only be added if there is not already a definition with
+     * the same name in the file.
+     *
+     * @mutates this.files
+     */
+    register({ imports, definitions, destinationPath, reExports, preview }: RegisterArgs): void;
+    /**
+     * Insert operation into the output file with path `destinationPath`.
+     *
+     * Insert will perform the following steps:
+     * 1. Generate content settings for the supplied operation
+     * 2. Look up definition in file with path `destinationPath`
+     * 3. If definition is not found, it will create a new one and register it
+     * 4. If the definition is defined at a location that is different from
+     *    the current file, it will add an import to the current file from
+     *    that location
+     * 5. Use the content settings to generate the operation using the
+     *    insertable's driver
+     * @mutates this.files
+     */
+    insertOperation<V extends GeneratedValue, T extends GenerationType, EnrichmentType>({ insertable, operation, generation, destinationPath }: InsertOperationArgs<V, T, EnrichmentType>): Inserted<V, T>;
+    /**
+     * Insert model into the output file with path `destinationPath`.
+     *
+     * Insert will perform the following steps:
+     * 1. Generate content settings for the supplied model
+     * 2. Look up definition in file with path `destinationPath`
+     * 3. If definition is not found, it will create a new one and register it
+     * 4. If the definition is defined at a location that is different from
+     *    the current file, it will add an import to the current file from
+     *    that location
+     * 5. Use the content settings to generate the model using the
+     *    insertable's driver
+     * @mutates this.files
+     */
+    insertModel<V extends GeneratedValue, T extends GenerationType, EnrichmentType>({ insertable, refName, generation, destinationPath }: InsertModelArgs<V, T, EnrichmentType>): Inserted<V, T>;
+    /**
+     * Generate and return content settings for operation insertable and
+     * operation.
+     *
+     * Content settings are produced by passing base settings and operation
+     * through toIdentifier and toExportPath static methods on the
+     * insertable.
+     * @param { operation, insertable }
+     * @returns
+     */
+    toOperationContentSettings<V, EnrichmentType>({ operation, insertable }: ToOperationSettingsArgs<V, EnrichmentType>): ContentSettings;
+    /**
+     * Generate and return content settings for model insertable and refName.
+     *
+     * Content settings are produced by passing base settings and refName
+     * through toIdentifier and toExportPath static methods on the
+     * insertable.
+     * @param { refName, insertable }
+     * @returns Content settings for model
+     */
+    toModelContentSettings<V, EnrichmentType>({ refName, insertable }: BuildModelSettingsArgs<V, EnrichmentType>): ContentSettings;
+    /**
+     * Generate and return content settings for a gateway
+     *
+     * Content settings are produced by passing base settings
+     * through toIdentifier, toExportPath methods on the gateway
+     * @param gateway
+     * @returns Content settings for model
+     */
+    toGatewayContentSetting<EnrichmentType>(gateway: OperationGateway<EnrichmentType>): ContentSettings;
+    /**
+     * Look up operation settings for a given generatorId, path and method.
+     * @param { generatorId, path, method }
+     * @returns Base settings for operation
+     */
+    toOperationSelected({ generatorId, path, method }: GetOperationSettingsArgs): Record<string, unknown> | undefined;
+    toModelSelected({ generatorId, refName }: GetModelSettingsArgs): Record<string, unknown> | undefined;
+    toGeneratorSettings(generatorId: string): ClientGeneratorSettings | undefined;
+    /**
+     * Perform one lookup of schema by `refName`.
+     * @param refName
+     * @returns Matching schema or ref
+     * @throws if schema is not found
+     */
+    resolveSchemaRefOnce(refName: RefName): OasSchema | OasRef<'schema'>;
+    /**
+     * Check if definition name `name` in file with path `exportPath`
+     * has already been created and registered.
+     *
+     * @param { name, exportPath }
+     * @returns Matching definition if found or `undefined` otherwise
+     */
+    findDefinition({ name, exportPath }: PickArgs): Definition | undefined;
+}
+export {};
+//# sourceMappingURL=GenerateContext.d.ts.map

package/script/context/GenerateContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GenerateContext.d.ts","sourceRoot":"","sources":["../../src/context/GenerateContext.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AAErD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACjD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAE/C,OAAO,KAAK,EAAE,uBAAuB,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACnF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAChD,OAAO,KAAK,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,yCAAyC,CAAA;AACpG,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAA;AACjE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAA;AAGtE,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAChF,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAC3D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAElD,OAAO,KAAK,KAAK,GAAG,MAAM,wCAAwC,CAAA;AAClE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,eAAe,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AAC3F,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAC7C,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAErC,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAE7E,KAAK,eAAe,GAAG;IACrB,WAAW,EAAE,WAAW,CAAA;IACxB,QAAQ,EAAE,cAAc,GAAG,SAAS,CAAA;IACpC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAA;IAClB,QAAQ,EAAE,CAAC,YAAY,EAAE,YAAY,KAAK,IAAI,CAAA;IAC9C,UAAU,EAAE,UAAU,CAAA;IACtB,oBAAoB,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,IAAI,CAAA;IAClD,eAAe,EAAE,CAAC,cAAc,OAAO,aAAa,CAClD,aAAa,CAAC,cAAc,CAAC,EAC7B,cAAc,CACf,CAAA;CACF,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,eAAe,EAAE,MAAM,CAAA;IACvB,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC,CAAA;IACzC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC,CAAA;IACxC,WAAW,CAAC,EAAE,CAAC,UAAU,GAAG,SAAS,CAAC,EAAE,CAAA;IACxC,OAAO,CAAC,EAAE;QACR,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;KACxB,CAAA;IACD,eAAe,EAAE,MAAM,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,2BAA2B,CAAC,MAAM,SAAS,UAAU,IAAI;IACnE,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,UAAU,CAAA;IACtB,eAAe,EAAE,MAAM,CAAA;IACvB,eAAe,EAAE,eAAe,CAAA;CACjC,CAAA;AAED,MAAM,MAAM,qBAAqB,CAAC,CAAC,SAAS,cAAc,IAAI;IAC5D,UAAU,EAAE,UAAU,CAAA;IACtB,KAAK,EAAE,CAAC,CAAA;IACR,eAAe,EAAE,MAAM,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,YAAY,CAAA;IACvB,YAAY,EAAE,MAAM,EAAE,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,mBAAmB,CAC7B,CAAC,SAAS,cAAc,EACxB,CAAC,SAAS,cAAc,EACxB,cAAc,IACZ;IACF,UAAU,EAAE,mBAAmB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAA;IAClD,SAAS,EAAE,YAAY,CAAA;IACvB,UAAU,CAAC,EAAE,CAAC,CAAA;IACd,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,cAAc,EAAE,CAAC,SAAS,cAAc,EAAE,cAAc,IAAI;IAChG,UAAU,EAAE,eAAe,CAAC,CAAC,EAAE,cAAc,CAAC,CAAA;IAC9C,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,CAAC,EAAE,CAAC,CAAA;IACd,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,cAAc,EAAE,CAAC,SAAS,cAAc,IAAI,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;AAY7F,KAAK,uBAAuB,CAAC,CAAC,EAAE,cAAc,IAAI;IAChD,SAAS,EAAE,YAAY,CAAA;IACvB,UAAU,EAAE,mBAAmB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAA;CACnD,CAAA;AAED,KAAK,sBAAsB,CAAC,CAAC,EAAE,cAAc,IAAI;IAC/C,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,EAAE,eAAe,CAAC,CAAC,EAAE,cAAc,CAAC,CAAA;CAC/C,CAAA;AAED,KAAK,cAAc,GAAG;IACpB,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;IACxB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;CACjD,CAAA;AAED,qBAAa,eAAe;;IAG1B,WAAW,EAAE,WAAW,CAAA;IACxB,QAAQ,EAAE,cAAc,GAAG,SAAS,CAAA;IACpC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAA;IAClB,QAAQ,EAAE,CAAC,YAAY,EAAE,YAAY,KAAK,IAAI,CAAA;IAC9C,oBAAoB,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,IAAI,CAAA;IAClD,eAAe,EAAE,CAAC,cAAc,OAAO,aAAa,CAClD,aAAa,CAAC,cAAc,CAAC,EAC7B,cAAc,CACf,CAAA;gBAIW,EACV,WAAW,EACX,QAAQ,EACR,MAAM,EACN,QAAQ,EACR,oBAAoB,EACpB,UAAU,EACV,eAAe,EAChB,EAAE,eAAe;IAYlB;;OAEG;IACH,QAAQ,IAAI,cAAc;IAiJ1B,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC;IAoBlD;;;;;;;;;;;;;;OAcG;IACH,2BAA2B,CAAC,MAAM,SAAS,UAAU,EAAE,EACrD,MAAM,EACN,UAAU,EACV,eAAe,EACf,eAAe,EAChB,EAAE,2BAA2B,CAAC,MAAM,CAAC,GAAG,UAAU,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IA0BrF;;;;OAIG;IACH,iBAAiB,CAAC,CAAC,SAAS,cAAc,EAAE,EAC1C,UAAU,EACV,KAAK,EACL,eAAe,EAChB,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC;IA6B3C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,OAAY,EAAE,WAAW,EAAE,eAAe,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,YAAY;IA2DzF;;;;;;;;;;;;;OAaG;IACH,eAAe,CAAC,CAAC,SAAS,cAAc,EAAE,CAAC,SAAS,cAAc,EAAE,cAAc,EAAE,EAClF,UAAU,EACV,SAAS,EACT,UAAU,EACV,eAAe,EAChB,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,EAAE,cAAc,CAAC,GAAG,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;IAY7D;;;;;;;;;;;;;OAaG;IAEH,WAAW,CAAC,CAAC,SAAS,cAAc,EAAE,CAAC,SAAS,cAAc,EAAE,cAAc,EAAE,EAC9E,UAAU,EACV,OAAO,EACP,UAAU,EACV,eAAe,EAChB,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,EAAE,cAAc,CAAC,GAAG,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;IAYzD;;;;;;;;;OASG;IACH,0BAA0B,CAAC,CAAC,EAAE,cAAc,EAAE,EAC5C,SAAS,EACT,UAAU,EACX,EAAE,uBAAuB,CAAC,CAAC,EAAE,cAAc,CAAC,GAAG,eAAe;IAc/D;;;;;;;;OAQG;IACH,sBAAsB,CAAC,CAAC,EAAE,cAAc,EAAE,EACxC,OAAO,EACP,UAAU,EACX,EAAE,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,GAAG,eAAe;IAa9D;;;;;;;OAOG;IACH,uBAAuB,CAAC,cAAc,EACpC,OAAO,EAAE,gBAAgB,CAAC,cAAc,CAAC,GACxC,eAAe;IAQlB;;;;OAIG;IACH,mBAAmB,CAAC,EAClB,WAAW,EACX,IAAI,EACJ,MAAM,EACP,EAAE,wBAAwB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;IAWjE,eAAe,CAAC,EACd,WAAW,EACX,OAAO,EACR,EAAE,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;IAW7D,mBAAmB,CAAC,WAAW,EAAE,MAAM,GAAG,uBAAuB,GAAG,SAAS;IAe7E;;;;;OAKG;IACH,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC;IAUpE;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS;CAGvE"}