ormbridge 0.8.0 → 0.9.0

package/dist/emitters/efcoreNames.d.ts

@@ -0,0 +1,30 @@
+/** Name and literal helpers of the Entity Framework Core emitter. */
+/** The namespace of the generated classes when none is given. */
+export declare const DEFAULT_EFCORE_NAMESPACE: string;
+/** Type names the generated code refers to, which a model of the same name would hide. */
+export declare const RESERVED_TYPE_NAMES: ReadonlySet<string>;
+/** Members every object has, or that `DbContext` has; a property of the same name would hide them. */
+export declare const RESERVED_MEMBER_NAMES: ReadonlySet<string>;
+/** Members of `DbContext` that a `DbSet` property must not take the name of. */
+export declare const DBCONTEXT_MEMBER_NAMES: ReadonlySet<string>;
+/** True for a valid C# identifier that is not a keyword. */
+export declare function isCsharpIdentifier(value: string): boolean;
+/** True for a dotted C# namespace such as `App.Models`. */
+export declare function isValidCsharpNamespace(value: string): boolean;
+/** Writes a name as an identifier: a keyword gets the `@` prefix. */
+export declare function verbatim(name: string): string;
+/**
+ * Turns any text into a valid PascalCase identifier. Returns undefined when nothing usable is left
+ * (a name made only of characters an identifier cannot hold).
+ */
+export declare function pascalIdentifier(raw: string): string | undefined;
+/** Keeps a name that is already a valid identifier and repairs one that is not. */
+export declare function repairedIdentifier(raw: string): string;
+/** Reserves `base` in `used`, appending a number when the name is taken. */
+export declare function uniqueName(base: string, used: Set<string>): string;
+/** Reserves a navigation name: a name that is taken gets the suffix `Ref` before a number is tried. */
+export declare function navigationName(base: string, used: Set<string>): string;
+/** A C# string literal. */
+export declare function csString(value: string): string;
+/** Pluralizes the last word of a PascalCase name: `BlogPost` is `BlogPosts`, `Category` `Categories`. */
+export declare function pluralize(name: string): string;

package/dist/emitters/efcoreNames.js

@@ -0,0 +1,268 @@
+import { toPascalCase } from '../naming.js';
+/** Name and literal helpers of the Entity Framework Core emitter. */
+/** The namespace of the generated classes when none is given. */
+export const DEFAULT_EFCORE_NAMESPACE = 'App.Models';
+const IDENTIFIER_PATTERN = /^[A-Za-z_][A-Za-z0-9_]*$/;
+/** C# keywords: an identifier with one of these names needs the `@` prefix. */
+const KEYWORDS = new Set([
+    'abstract',
+    'as',
+    'base',
+    'bool',
+    'break',
+    'byte',
+    'case',
+    'catch',
+    'char',
+    'checked',
+    'class',
+    'const',
+    'continue',
+    'decimal',
+    'default',
+    'delegate',
+    'do',
+    'double',
+    'else',
+    'enum',
+    'event',
+    'explicit',
+    'extern',
+    'false',
+    'finally',
+    'fixed',
+    'float',
+    'for',
+    'foreach',
+    'goto',
+    'if',
+    'implicit',
+    'in',
+    'int',
+    'interface',
+    'internal',
+    'is',
+    'lock',
+    'long',
+    'namespace',
+    'new',
+    'null',
+    'object',
+    'operator',
+    'out',
+    'override',
+    'params',
+    'private',
+    'protected',
+    'public',
+    'readonly',
+    'ref',
+    'return',
+    'sbyte',
+    'sealed',
+    'short',
+    'sizeof',
+    'stackalloc',
+    'static',
+    'string',
+    'struct',
+    'switch',
+    'this',
+    'throw',
+    'true',
+    'try',
+    'typeof',
+    'uint',
+    'ulong',
+    'unchecked',
+    'unsafe',
+    'ushort',
+    'using',
+    'virtual',
+    'void',
+    'volatile',
+    'while',
+]);
+/** Type names the generated code refers to, which a model of the same name would hide. */
+export const RESERVED_TYPE_NAMES = new Set([
+    'Array',
+    'Attribute',
+    'Boolean',
+    'Byte',
+    'ChangeTracker',
+    'DateOnly',
+    'DateTime',
+    'Decimal',
+    'DeleteBehavior',
+    'Dictionary',
+    'Double',
+    'DbContext',
+    'DbContextOptions',
+    'DbSet',
+    'ICollection',
+    'IEntityTypeConfiguration',
+    'Int32',
+    'Int64',
+    'IPAddress',
+    'Guid',
+    'List',
+    'ModelBuilder',
+    'Nullable',
+    'NpgsqlRange',
+    'Object',
+    'String',
+    'Task',
+    'TimeOnly',
+    'TimeSpan',
+    'Type',
+    'ValueConverter',
+]);
+/** Members every object has, or that `DbContext` has; a property of the same name would hide them. */
+export const RESERVED_MEMBER_NAMES = new Set([
+    'Equals',
+    'Finalize',
+    'GetHashCode',
+    'GetType',
+    'MemberwiseClone',
+    'ReferenceEquals',
+    'ToString',
+]);
+/** Members of `DbContext` that a `DbSet` property must not take the name of. */
+export const DBCONTEXT_MEMBER_NAMES = new Set([
+    'ChangeTracker',
+    'ContextId',
+    'Database',
+    'Dispose',
+    'Entry',
+    'Model',
+    'SaveChanges',
+    'Set',
+]);
+/** True for a valid C# identifier that is not a keyword. */
+export function isCsharpIdentifier(value) {
+    return IDENTIFIER_PATTERN.test(value) && !KEYWORDS.has(value);
+}
+/** True for a dotted C# namespace such as `App.Models`. */
+export function isValidCsharpNamespace(value) {
+    return (value.length > 0 &&
+        value.split('.').every((part) => isCsharpIdentifier(part)));
+}
+/** Writes a name as an identifier: a keyword gets the `@` prefix. */
+export function verbatim(name) {
+    return KEYWORDS.has(name) ? `@${name}` : name;
+}
+/**
+ * Turns any text into a valid PascalCase identifier. Returns undefined when nothing usable is left
+ * (a name made only of characters an identifier cannot hold).
+ */
+export function pascalIdentifier(raw) {
+    const pascal = toPascalCase(raw);
+    if (pascal === '') {
+        return undefined;
+    }
+    return /^[0-9]/.test(pascal) ? `_${pascal}` : pascal;
+}
+/** Keeps a name that is already a valid identifier and repairs one that is not. */
+export function repairedIdentifier(raw) {
+    if (IDENTIFIER_PATTERN.test(raw)) {
+        return raw;
+    }
+    const replaced = raw.replace(/[^A-Za-z0-9_]/g, '_');
+    const prefixed = /^[0-9]/.test(replaced) ? `_${replaced}` : replaced;
+    return prefixed === '' || /^_+$/.test(prefixed) ? 'Value' : prefixed;
+}
+/** Reserves `base` in `used`, appending a number when the name is taken. */
+export function uniqueName(base, used) {
+    let candidate = base;
+    let suffix = 2;
+    while (used.has(candidate)) {
+        candidate = `${base}${suffix}`;
+        suffix += 1;
+    }
+    used.add(candidate);
+    return candidate;
+}
+/** Reserves a navigation name: a name that is taken gets the suffix `Ref` before a number is tried. */
+export function navigationName(base, used) {
+    return uniqueName(used.has(base) ? `${base}Ref` : base, used);
+}
+/** A C# string literal. */
+export function csString(value) {
+    let escaped = '';
+    for (const character of value) {
+        const code = character.codePointAt(0) ?? 0;
+        switch (character) {
+            case '\\':
+                escaped += '\\\\';
+                break;
+            case '"':
+                escaped += '\\"';
+                break;
+            case '\n':
+                escaped += '\\n';
+                break;
+            case '\r':
+                escaped += '\\r';
+                break;
+            case '\t':
+                escaped += '\\t';
+                break;
+            default:
+                escaped +=
+                    code < 0x20 || code === 0x7f
+                        ? `\\u${code.toString(16).padStart(4, '0')}`
+                        : character;
+        }
+    }
+    return `"${escaped}"`;
+}
+const UNCOUNTABLE = new Set([
+    'series',
+    'news',
+    'species',
+    'sheep',
+    'fish',
+    'equipment',
+    'information',
+    'metadata',
+    'data',
+    'media',
+]);
+const IRREGULAR = {
+    person: 'people',
+    child: 'children',
+    man: 'men',
+    woman: 'women',
+};
+function pluralizeWord(word) {
+    const lower = word.toLowerCase();
+    if (UNCOUNTABLE.has(lower)) {
+        return word;
+    }
+    const irregular = IRREGULAR[lower];
+    if (irregular !== undefined) {
+        return word.charAt(0) === word.charAt(0).toUpperCase()
+            ? irregular.charAt(0).toUpperCase() + irregular.slice(1)
+            : irregular;
+    }
+    if (/[^s]s$/.test(lower) && !/(us|is|ous)$/.test(lower)) {
+        // Already plural (`PostTags`).
+        return word;
+    }
+    if (/(s|x|z|ch|sh)$/.test(lower)) {
+        return `${word}es`;
+    }
+    if (/[^aeiou]y$/.test(lower)) {
+        return `${word.slice(0, -1)}ies`;
+    }
+    return `${word}s`;
+}
+/** Pluralizes the last word of a PascalCase name: `BlogPost` is `BlogPosts`, `Category` `Categories`. */
+export function pluralize(name) {
+    const match = name.match(/^(.*?)([A-Z][a-z0-9]*|[a-z0-9]+)$/);
+    if (match === null) {
+        return `${name}s`;
+    }
+    return `${match[1] ?? ''}${pluralizeWord(match[2] ?? '')}`;
+}
+//# sourceMappingURL=efcoreNames.js.map

package/dist/emitters/efcoreNames.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"efcoreNames.js","sourceRoot":"","sources":["../../src/emitters/efcoreNames.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAE5C,qEAAqE;AAErE,iEAAiE;AACjE,MAAM,CAAC,MAAM,wBAAwB,GAAW,YAAY,CAAC;AAE7D,MAAM,kBAAkB,GAAW,0BAA0B,CAAC;AAE9D,+EAA+E;AAC/E,MAAM,QAAQ,GAAwB,IAAI,GAAG,CAAC;IAC5C,UAAU;IACV,IAAI;IACJ,MAAM;IACN,MAAM;IACN,OAAO;IACP,MAAM;IACN,MAAM;IACN,OAAO;IACP,MAAM;IACN,SAAS;IACT,OAAO;IACP,OAAO;IACP,UAAU;IACV,SAAS;IACT,SAAS;IACT,UAAU;IACV,IAAI;IACJ,QAAQ;IACR,MAAM;IACN,MAAM;IACN,OAAO;IACP,UAAU;IACV,QAAQ;IACR,OAAO;IACP,SAAS;IACT,OAAO;IACP,OAAO;IACP,KAAK;IACL,SAAS;IACT,MAAM;IACN,IAAI;IACJ,UAAU;IACV,IAAI;IACJ,KAAK;IACL,WAAW;IACX,UAAU;IACV,IAAI;IACJ,MAAM;IACN,MAAM;IACN,WAAW;IACX,KAAK;IACL,MAAM;IACN,QAAQ;IACR,UAAU;IACV,KAAK;IACL,UAAU;IACV,QAAQ;IACR,SAAS;IACT,WAAW;IACX,QAAQ;IACR,UAAU;IACV,KAAK;IACL,QAAQ;IACR,OAAO;IACP,QAAQ;IACR,OAAO;IACP,QAAQ;IACR,YAAY;IACZ,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,MAAM;IACN,OAAO;IACP,MAAM;IACN,KAAK;IACL,QAAQ;IACR,MAAM;IACN,OAAO;IACP,WAAW;IACX,QAAQ;IACR,QAAQ;IACR,OAAO;IACP,SAAS;IACT,MAAM;IACN,UAAU;IACV,OAAO;CACR,CAAC,CAAC;AAEH,0FAA0F;AAC1F,MAAM,CAAC,MAAM,mBAAmB,GAAwB,IAAI,GAAG,CAAC;IAC9D,OAAO;IACP,WAAW;IACX,SAAS;IACT,MAAM;IACN,eAAe;IACf,UAAU;IACV,UAAU;IACV,SAAS;IACT,gBAAgB;IAChB,YAAY;IACZ,QAAQ;IACR,WAAW;IACX,kBAAkB;IAClB,OAAO;IACP,aAAa;IACb,0BAA0B;IAC1B,OAAO;IACP,OAAO;IACP,WAAW;IACX,MAAM;IACN,MAAM;IACN,cAAc;IACd,UAAU;IACV,aAAa;IACb,QAAQ;IACR,QAAQ;IACR,MAAM;IACN,UAAU;IACV,UAAU;IACV,MAAM;IACN,gBAAgB;CACjB,CAAC,CAAC;AAEH,sGAAsG;AACtG,MAAM,CAAC,MAAM,qBAAqB,GAAwB,IAAI,GAAG,CAAC;IAChE,QAAQ;IACR,UAAU;IACV,aAAa;IACb,SAAS;IACT,iBAAiB;IACjB,iBAAiB;IACjB,UAAU;CACX,CAAC,CAAC;AAEH,gFAAgF;AAChF,MAAM,CAAC,MAAM,sBAAsB,GAAwB,IAAI,GAAG,CAAC;IACjE,eAAe;IACf,WAAW;IACX,UAAU;IACV,SAAS;IACT,OAAO;IACP,OAAO;IACP,aAAa;IACb,KAAK;CACN,CAAC,CAAC;AAEH,4DAA4D;AAC5D,MAAM,UAAU,kBAAkB,CAAC,KAAa;IAC9C,OAAO,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;AAChE,CAAC;AAED,2DAA2D;AAC3D,MAAM,UAAU,sBAAsB,CAAC,KAAa;IAClD,OAAO,CACL,KAAK,CAAC,MAAM,GAAG,CAAC;QAChB,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CACnE,CAAC;AACJ,CAAC;AAED,qEAAqE;AACrE,MAAM,UAAU,QAAQ,CAAC,IAAY;IACnC,OAAO,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;AAChD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,GAAW;IAC1C,MAAM,MAAM,GAAW,YAAY,CAAC,GAAG,CAAC,CAAC;IACzC,IAAI,MAAM,KAAK,EAAE,EAAE,CAAC;QAClB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,MAAM,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;AACvD,CAAC;AAED,mFAAmF;AACnF,MAAM,UAAU,kBAAkB,CAAC,GAAW;IAC5C,IAAI,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACjC,OAAO,GAAG,CAAC;IACb,CAAC;IACD,MAAM,QAAQ,GAAW,GAAG,CAAC,OAAO,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;IAC5D,MAAM,QAAQ,GAAW,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,QAAQ,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;IAC7E,OAAO,QAAQ,KAAK,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC;AACvE,CAAC;AAED,4EAA4E;AAC5E,MAAM,UAAU,UAAU,CAAC,IAAY,EAAE,IAAiB;IACxD,IAAI,SAAS,GAAW,IAAI,CAAC;IAC7B,IAAI,MAAM,GAAW,CAAC,CAAC;IACvB,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;QAC3B,SAAS,GAAG,GAAG,IAAI,GAAG,MAAM,EAAE,CAAC;QAC/B,MAAM,IAAI,CAAC,CAAC;IACd,CAAC;IACD,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACpB,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,uGAAuG;AACvG,MAAM,UAAU,cAAc,CAAC,IAAY,EAAE,IAAiB;IAC5D,OAAO,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AAChE,CAAC;AAED,2BAA2B;AAC3B,MAAM,UAAU,QAAQ,CAAC,KAAa;IACpC,IAAI,OAAO,GAAW,EAAE,CAAC;IACzB,KAAK,MAAM,SAAS,IAAI,KAAK,EAAE,CAAC;QAC9B,MAAM,IAAI,GAAW,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACnD,QAAQ,SAAS,EAAE,CAAC;YAClB,KAAK,IAAI;gBACP,OAAO,IAAI,MAAM,CAAC;gBAClB,MAAM;YACR,KAAK,GAAG;gBACN,OAAO,IAAI,KAAK,CAAC;gBACjB,MAAM;YACR,KAAK,IAAI;gBACP,OAAO,IAAI,KAAK,CAAC;gBACjB,MAAM;YACR,KAAK,IAAI;gBACP,OAAO,IAAI,KAAK,CAAC;gBACjB,MAAM;YACR,KAAK,IAAI;gBACP,OAAO,IAAI,KAAK,CAAC;gBACjB,MAAM;YACR;gBACE,OAAO;oBACL,IAAI,GAAG,IAAI,IAAI,IAAI,KAAK,IAAI;wBAC1B,CAAC,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE;wBAC5C,CAAC,CAAC,SAAS,CAAC;QACpB,CAAC;IACH,CAAC;IACD,OAAO,IAAI,OAAO,GAAG,CAAC;AACxB,CAAC;AAED,MAAM,WAAW,GAAwB,IAAI,GAAG,CAAC;IAC/C,QAAQ;IACR,MAAM;IACN,SAAS;IACT,OAAO;IACP,MAAM;IACN,WAAW;IACX,aAAa;IACb,UAAU;IACV,MAAM;IACN,OAAO;CACR,CAAC,CAAC;AAEH,MAAM,SAAS,GAAqC;IAClD,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAE,UAAU;IACjB,GAAG,EAAE,KAAK;IACV,KAAK,EAAE,OAAO;CACf,CAAC;AAEF,SAAS,aAAa,CAAC,IAAY;IACjC,MAAM,KAAK,GAAW,IAAI,CAAC,WAAW,EAAE,CAAC;IACzC,IAAI,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,SAAS,GAAuB,SAAS,CAAC,KAAK,CAAC,CAAC;IACvD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE;YACpD,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;YACxD,CAAC,CAAC,SAAS,CAAC;IAChB,CAAC;IACD,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACxD,+BAA+B;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACjC,OAAO,GAAG,IAAI,IAAI,CAAC;IACrB,CAAC;IACD,IAAI,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7B,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;IACnC,CAAC;IACD,OAAO,GAAG,IAAI,GAAG,CAAC;AACpB,CAAC;AAED,yGAAyG;AACzG,MAAM,UAAU,SAAS,CAAC,IAAY;IACpC,MAAM,KAAK,GAA4B,IAAI,CAAC,KAAK,CAC/C,mCAAmC,CACpC,CAAC;IACF,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACnB,OAAO,GAAG,IAAI,GAAG,CAAC;IACpB,CAAC;IACD,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;AAC7D,CAAC"}

package/dist/emitters/efcoreRender.d.ts

@@ -0,0 +1,2 @@
+import type { Plan } from './efcoreTypes.js';
+export declare function renderFiles(plan: Plan): Record<string, string>;