@baseplate-dev/project-builder-lib 0.1.1

package/dist/references/types.d.ts

@@ -0,0 +1,126 @@
+export type ReferencePath = (string | number)[];
+/**
+ * Definition of an entity type.
+ */
+export declare class DefinitionEntityType<THasParent extends boolean = boolean> {
+    readonly name: string;
+    readonly parentType?: (THasParent extends true ? DefinitionEntityType : undefined) | undefined;
+    readonly prefix: string;
+    /**
+     * Creates a new entity type.
+     *
+     * @param name - The name of the entity type.
+     * @param prefix - The prefix of the entity type to use in the ID, defaults to the name.
+     * @param parentType - The type of the parent entity if any
+     */
+    constructor(name: string, prefix?: string, parentType?: (THasParent extends true ? DefinitionEntityType : undefined) | undefined);
+    /**
+     * Generates a new ID for the entity type.
+     *
+     * @returns The new ID.
+     */
+    generateNewId(): string;
+    /**
+     * Converts a UID to an ID.
+     *
+     * @param uid - The UID to convert.
+     * @returns The ID.
+     */
+    fromUid(uid: string): string;
+    fromUid(uid: string | undefined): string | undefined;
+    toUid(id: string): string;
+    isId(id: string): boolean;
+}
+/**
+ * An entity in the project definition, e.g. a model, enum, or field.
+ */
+export interface DefinitionEntity {
+    /**
+     * The ID of the entity.
+     */
+    id: string;
+    /**
+     * The name of the entity.
+     */
+    name: string;
+    /**
+     * The type of the entity.
+     */
+    type: DefinitionEntityType;
+    /**
+     * The path to the entity in the definition.
+     */
+    path: ReferencePath;
+    /**
+     * The path to the entity's ID.
+     */
+    idPath: ReferencePath;
+    /**
+     * The path to the entity's parent in the definition.
+     */
+    parentPath?: ReferencePath;
+}
+type ReferenceOnDeleteAction = 
+/**
+ * Set the reference to null.
+ */
+'SET_NULL'
+/**
+ * Delete the entity.
+ */
+ | 'DELETE'
+/**
+ * Delete the parent entity.
+ */
+ | 'DELETE_PARENT'
+/**
+ * Throw an error if the referenced entity is deleted.
+ */
+ | 'RESTRICT';
+/**
+ * A reference to an entity.
+ */
+export interface DefinitionReference {
+    /**
+     * The type of the entity.
+     */
+    type: DefinitionEntityType;
+    /**
+     * The path to the entity in the definition.
+     */
+    path: ReferencePath;
+    /**
+     * The path to the entity's parent in the definition.
+     */
+    parentPath?: ReferencePath;
+    /**
+     * The action to take when the referenced entity is deleted.
+     */
+    onDelete: ReferenceOnDeleteAction;
+}
+export declare function createEntityType(name: string): DefinitionEntityType<false>;
+export declare function createEntityType<TParent extends DefinitionEntityType | undefined = undefined>(name: string, options: {
+    parentType?: TParent;
+    prefix?: string;
+}): DefinitionEntityType<TParent extends undefined ? false : true>;
+/**
+ * A payload with resolved entity names.
+ *
+ * @template T - The type of the payload.
+ */
+export interface ResolvedZodRefPayload<T> {
+    /**
+     * The parsed data.
+     */
+    data: T;
+    /**
+     * The entities with resolved names.
+     */
+    entities: DefinitionEntity[];
+    /**
+     * The references in the definition.
+     */
+    references: DefinitionReference[];
+}
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/references/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/references/types.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,aAAa,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;AAEhD;;GAEG;AACH,qBAAa,oBAAoB,CAAC,UAAU,SAAS,OAAO,GAAG,OAAO;aAWlD,IAAI,EAAE,MAAM;aAEZ,UAAU,CAAC,GAAE,UAAU,SAAS,IAAI,GAChD,oBAAoB,GACpB,SAAS;IAdf,SAAgB,MAAM,EAAE,MAAM,CAAC;IAE/B;;;;;;OAMG;gBAEe,IAAI,EAAE,MAAM,EAC5B,MAAM,CAAC,EAAE,MAAM,EACC,UAAU,CAAC,GAAE,UAAU,SAAS,IAAI,GAChD,oBAAoB,GACpB,SAAS,aAAA;IAKf;;;;OAIG;IACH,aAAa,IAAI,MAAM;IAIvB;;;;;OAKG;IACH,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAC5B,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS;IAQpD,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM;IAIzB,IAAI,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;CAG1B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,EAAE,oBAAoB,CAAC;IAC3B;;OAEG;IACH,IAAI,EAAE,aAAa,CAAC;IACpB;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IACtB;;OAEG;IACH,UAAU,CAAC,EAAE,aAAa,CAAC;CAC5B;AAED,KAAK,uBAAuB;AAC1B;;GAEG;AACD,UAAU;AACZ;;GAEG;GACD,QAAQ;AACV;;GAEG;GACD,eAAe;AACjB;;GAEG;GACD,UAAU,CAAC;AAEf;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,oBAAoB,CAAC;IAC3B;;OAEG;IACH,IAAI,EAAE,aAAa,CAAC;IACpB;;OAEG;IACH,UAAU,CAAC,EAAE,aAAa,CAAC;IAC3B;;OAEG;IACH,QAAQ,EAAE,uBAAuB,CAAC;CACnC;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;AAE5E,wBAAgB,gBAAgB,CAC9B,OAAO,SAAS,oBAAoB,GAAG,SAAS,GAAG,SAAS,EAE5D,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE;IAAE,UAAU,CAAC,EAAE,OAAO,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GACjD,oBAAoB,CAAC,OAAO,SAAS,SAAS,GAAG,KAAK,GAAG,IAAI,CAAC,CAAC;AAgBlE;;;;GAIG;AACH,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC;;OAEG;IACH,IAAI,EAAE,CAAC,CAAC;IACR;;OAEG;IACH,QAAQ,EAAE,gBAAgB,EAAE,CAAC;IAC7B;;OAEG;IACH,UAAU,EAAE,mBAAmB,EAAE,CAAC;CACnC"}

package/dist/references/types.js

@@ -0,0 +1,59 @@
+import { randomUid } from '@baseplate-dev/utils';
+/**
+ * Definition of an entity type.
+ */
+export class DefinitionEntityType {
+    /**
+     * Creates a new entity type.
+     *
+     * @param name - The name of the entity type.
+     * @param prefix - The prefix of the entity type to use in the ID, defaults to the name.
+     * @param parentType - The type of the parent entity if any
+     */
+    constructor(name, prefix, parentType) {
+        Object.defineProperty(this, "name", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: name
+        });
+        Object.defineProperty(this, "parentType", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: parentType
+        });
+        Object.defineProperty(this, "prefix", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.prefix = prefix ?? name.split('/').pop() ?? name;
+    }
+    /**
+     * Generates a new ID for the entity type.
+     *
+     * @returns The new ID.
+     */
+    generateNewId() {
+        return `${this.prefix}:${randomUid()}`;
+    }
+    fromUid(uid) {
+        if (!uid) {
+            return undefined;
+        }
+        return `${this.prefix}:${uid}`;
+    }
+    toUid(id) {
+        return id.split(':')[1];
+    }
+    isId(id) {
+        return id.startsWith(`${this.prefix}:`);
+    }
+}
+export function createEntityType(name, options) {
+    const { parentType, prefix } = options ?? {};
+    return new DefinitionEntityType(name, prefix, parentType);
+}
+//# sourceMappingURL=types.js.map

package/dist/references/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/references/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAIjD;;GAEG;AACH,MAAM,OAAO,oBAAoB;IAG/B;;;;;;OAMG;IACH,YACkB,IAAY,EAC5B,MAAe,EACC,UAEH;QAJb;;;;mBAAgB,IAAI;WAAQ;QAE5B;;;;mBAAgB,UAAU;WAEb;QAdC;;;;;WAAe;QAgB7B,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACH,aAAa;QACX,OAAO,GAAG,IAAI,CAAC,MAAM,IAAI,SAAS,EAAE,EAAE,CAAC;IACzC,CAAC;IAUD,OAAO,CAAC,GAAuB;QAC7B,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,GAAG,IAAI,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;IACjC,CAAC;IAED,KAAK,CAAC,EAAU;QACd,OAAO,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1B,CAAC;IAED,IAAI,CAAC,EAAU;QACb,OAAO,EAAE,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IAC1C,CAAC;CACF;AAiFD,MAAM,UAAU,gBAAgB,CAC9B,IAAY,EACZ,OAAmD;IAEnD,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IAC7C,OAAO,IAAI,oBAAoB,CAC7B,IAAI,EACJ,MAAM,EACN,UAEa,CACd,CAAC;AACJ,CAAC"}