@servicenow/sdk-build-core 4.6.0 → 4.7.0

package/dist/plugins/plugin.d.ts

@@ -67,37 +67,12 @@ export type Relationship = {
 };
 export type CoalesceStrategy = [string, ...string[]] | ((properties: ObjectShape) => globalThis.Record<string, string | StringShape> | ObjectShape);
 export type FileType = 'fluent' | 'module' | 'json' | 'unknown';
-export type PluginApiDoc = {
-    /**
-     * The name of the API (e.g., 'BusinessRule', 'Acl', 'Table')
-     * This is the callee name used in fluent code.
-     */
-    apiName: string;
-    /**
-     * Tags for categorizing and organizing the API documentation
-     */
-    tags: string[];
-};
-/**
- * Manifest structure for API documentation.
- */
-export type DocsManifest = {
-    [apiName: string]: {
-        docPath: string;
-        tags: string[];
-    };
-};
 export type PluginConfig<Nodes extends SupportedKindName[] = SupportedKindName[], Shapes extends ShapeClass[] = ShapeClass[], Records extends string[] = string[]> = {
     /**
      * The name of the plugin. Must end with "Plugin" suffix. This name is used in metrics
      * and error messages.
      */
     name: `${string}Plugin`;
-    /**
-     * Documentation for the APIs provided by this plugin. This is used to automatically
-     * generate documentation that can be retrieved via the getDocsMetadata() method.
-     */
-    docs: PluginApiDoc[];
     /**
      * The TypeScript AST nodes this plugin handles. Plugins that do not introduce new
      * syntax should not need to define any handlers here.
@@ -364,7 +339,7 @@ export type PluginConfig<Nodes extends SupportedKindName[] = SupportedKindName[]
         /**
          * A regex pattern or predicate to apply to a file's path to determine if it should be handled by this plugin.
          */
-        matcher?: RegExp | ((path: string, context: Context) => boolean | Promise<boolean>);
+        matcher?: RegExp | FileMatcher;
         /**
          * Indicates whether this file should be parsed as an entry point when generating output. (Default: false)
          */
@@ -379,15 +354,25 @@ export type PluginConfig<Nodes extends SupportedKindName[] = SupportedKindName[]
          */
         toRecord?(file: File, context: Context): Result<Record> | Promise<Result<Record>>;
     }[];
+    /**
+     * @deprecated This property is no longer read and will be removed in a
+     * future release.
+     */
+    docs?: any[];
 };
 type SearchableRelationships = {
     [table: string]: Relationships;
 };
+type FileMatcher = (path: string, context: Context) => boolean | Promise<boolean>;
+type EntryPoints = {
+    readonly nodes: Map<SupportedKindName, Set<FileType | '*'>>;
+    readonly files: {
+        readonly plugin: Plugin;
+        readonly matcher: RegExp | FileMatcher;
+    }[];
+};
 export declare class Plugin {
     private readonly config;
-    private readonly nodeToShapeCache;
-    private readonly shapeToSubclassCache;
-    private readonly shapeToRecordCache;
     private readonly relationships;
     private readonly references;
     private constructor();
@@ -518,14 +503,6 @@ export declare class Plugin {
      */
     static create<const N extends SupportedKindName[], const S extends ShapeClass[]>(config: PluginConfig<N, S>): Plugin;
     getName(): string;
-    /**
-     * Get documentation metadata for APIs provided by this plugin.
-     */
-    getDocsMetadata(): {
-        [apiName: string]: {
-            tags: string[];
-        };
-    } | undefined;
     getDescendants(parent: Record, database: Database): Record[];
     private traverseDescendants;
     getCoalesceStrategy(table: string): CoalesceStrategy | undefined;
@@ -535,20 +512,18 @@ export declare class Plugin {
         [column: string]: string;
     };
     getRelationships(): SearchableRelationships;
-    flushCache(): void;
-    nodeToShape(node: SupportedNode, context: Omit<Context, 'self'>): Promise<Result<Shape>>;
     commit(shape: Shape, target: ts.Node, context: Omit<CommitContext, 'self'>): Promise<CommitResult>;
     getTarget(shape: Shape, context: Omit<Context, 'self'>): Promise<Result<ts.Node>>;
-    shapeToSubclass<const S extends Shape>(shape: S, context: Omit<Context, 'self'>): Promise<Result<S>>;
-    shapeToRecord(shape: Shape, context: Omit<Context, 'self'>): Promise<Result<Record>>;
     private recordToShape0;
-    recordToShape({ record, database, context, }: {
+    recordToShape({ record, database, existingDatabase, context, }: {
         record: Record;
         database: Database;
+        existingDatabase?: Database;
         context: Omit<Context, 'self'>;
     }): Promise<Result<Shape>>;
-    recordsToShapes({ database, creatorOnly, changedOnly, mode, handledRecords, context, }: {
+    recordsToShapes({ database, existingDatabase, creatorOnly, changedOnly, mode, handledRecords, context, }: {
         database: Database;
+        existingDatabase?: Database;
         creatorOnly: boolean;
         changedOnly?: boolean;
         mode: 'explicit' | 'catch-all';
@@ -570,18 +545,30 @@ export declare class Plugin {
         handledGuids: Set<string>;
         context: Omit<Context, 'self'>;
     }): Promise<Result<OutputFile[]>>;
-    isEntryPoint(pathOrNode: string | SupportedNode, context: Omit<Context, 'self'>): Promise<boolean>;
+    getEntryPoints(): EntryPoints;
     fileToRecord(file: File, context: Omit<Context, 'self'>): Promise<Result<Record>>;
     inspect(shape: Shape, context: Omit<Context, 'self'>): void;
     getUpdateName(record: Record, context: Omit<Context, 'self'>): Promise<Result<string>>;
+    getConfig(): PluginConfig;
 }
-export declare class Plugins {
-    private readonly plugins;
+export declare class Plugins implements Iterable<Plugin> {
+    private plugins;
+    private nodeToShapeCache;
+    private shapeToSubclassCache;
+    private shapeToRecordCache;
+    private readonly entryPoints;
     constructor(plugins: Plugin[]);
-    toArray(): Plugin[];
-    remove(name: string): void;
+    private static createEntry;
+    private get;
+    [Symbol.iterator](): Iterator<Plugin>;
+    reload(): void;
     prepend(...plugins: Plugin[]): void;
     append(...plugins: Plugin[]): void;
+    getShapeCountPerPlugin(): {
+        plugin: string;
+        count: number;
+    }[];
+    clearShapeCounts(): void;
     getCoalesceStrategy(table: string): CoalesceStrategy | undefined;
     isComposite(table: string): boolean;
     getCoalesceTables(): Set<string>;
@@ -589,10 +576,11 @@ export declare class Plugins {
         [column: string]: string;
     };
     isEntryPoint(pathOrNode: string | SupportedNode, context: Omit<Context, 'self'>): Promise<boolean>;
-    getDocsMetadata(): {
-        [apiName: string]: {
-            tags: string[];
-        };
-    };
+    nodeToShape(node: SupportedNode, context: Omit<Context, 'self'>, ...plugins: (string | Plugin)[]): Promise<Result<Shape>>;
+    private nodeToShape0;
+    shapeToSubclass<const S extends Shape>(shape: S, context: Omit<Context, 'self'>, ...plugins: (string | Plugin)[]): Promise<S>;
+    private shapeToSubclass0;
+    shapeToRecord(shape: Shape, context: Omit<Context, 'self'>, ...plugins: (string | Plugin)[]): Promise<Result<Record>>;
+    private shapeToRecord0;
 }
 export {};