cloesce 0.0.4-unstable.9 → 0.0.5-unstable.1

package/dist/extractor/err.d.ts

@@ -0,0 +1,32 @@
+export declare enum ExtractorErrorCode {
+  MissingExport = 0,
+  AppMissingDefaultExport = 1,
+  UnknownType = 2,
+  MultipleGenericType = 3,
+  InvalidDataSourceDefinition = 4,
+  InvalidPartialType = 5,
+  InvalidIncludeTree = 6,
+  InvalidAttributeModifier = 7,
+  InvalidApiMethodModifier = 8,
+  UnknownNavigationPropertyReference = 9,
+  InvalidNavigationPropertyReference = 10,
+  MissingNavigationPropertyReference = 11,
+  MissingManyToManyUniqueId = 12,
+  MissingPrimaryKey = 13,
+  MissingDatabaseBinding = 14,
+  TooManyWranglerEnvs = 15,
+  MissingFile = 16,
+  InvalidServiceAttribute = 17,
+}
+export declare function getErrorInfo(code: ExtractorErrorCode): {
+  description: string;
+  suggestion: string;
+};
+export declare class ExtractorError {
+  code: ExtractorErrorCode;
+  context?: string;
+  snippet?: string;
+  constructor(code: ExtractorErrorCode);
+  addContext(fn: (val: string | undefined) => string | undefined): void;
+}
+//# sourceMappingURL=err.d.ts.map

package/dist/extractor/err.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"err.d.ts","sourceRoot":"","sources":["../../src/extractor/err.ts"],"names":[],"mappings":"AAAA,oBAAY,kBAAkB;IAC5B,aAAa,IAAA;IACb,uBAAuB,IAAA;IACvB,WAAW,IAAA;IACX,mBAAmB,IAAA;IACnB,2BAA2B,IAAA;IAC3B,kBAAkB,IAAA;IAClB,kBAAkB,IAAA;IAClB,wBAAwB,IAAA;IACxB,wBAAwB,IAAA;IACxB,kCAAkC,IAAA;IAClC,kCAAkC,KAAA;IAClC,kCAAkC,KAAA;IAClC,yBAAyB,KAAA;IACzB,iBAAiB,KAAA;IACjB,sBAAsB,KAAA;IACtB,mBAAmB,KAAA;IACnB,WAAW,KAAA;IACX,uBAAuB,KAAA;CACxB;AA0FD,wBAAgB,YAAY,CAAC,IAAI,EAAE,kBAAkB;iBAtFpC,MAAM;gBAAc,MAAM;EAwF1C;AAED,qBAAa,cAAc;IAIN,IAAI,EAAE,kBAAkB;IAH3C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;gBAEE,IAAI,EAAE,kBAAkB;IAE3C,UAAU,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,KAAK,MAAM,GAAG,SAAS;CAG/D"}

package/dist/extractor/err.js

@@ -0,0 +1,138 @@
+export var ExtractorErrorCode;
+(function (ExtractorErrorCode) {
+  ExtractorErrorCode[(ExtractorErrorCode["MissingExport"] = 0)] =
+    "MissingExport";
+  ExtractorErrorCode[(ExtractorErrorCode["AppMissingDefaultExport"] = 1)] =
+    "AppMissingDefaultExport";
+  ExtractorErrorCode[(ExtractorErrorCode["UnknownType"] = 2)] = "UnknownType";
+  ExtractorErrorCode[(ExtractorErrorCode["MultipleGenericType"] = 3)] =
+    "MultipleGenericType";
+  ExtractorErrorCode[(ExtractorErrorCode["InvalidDataSourceDefinition"] = 4)] =
+    "InvalidDataSourceDefinition";
+  ExtractorErrorCode[(ExtractorErrorCode["InvalidPartialType"] = 5)] =
+    "InvalidPartialType";
+  ExtractorErrorCode[(ExtractorErrorCode["InvalidIncludeTree"] = 6)] =
+    "InvalidIncludeTree";
+  ExtractorErrorCode[(ExtractorErrorCode["InvalidAttributeModifier"] = 7)] =
+    "InvalidAttributeModifier";
+  ExtractorErrorCode[(ExtractorErrorCode["InvalidApiMethodModifier"] = 8)] =
+    "InvalidApiMethodModifier";
+  ExtractorErrorCode[
+    (ExtractorErrorCode["UnknownNavigationPropertyReference"] = 9)
+  ] = "UnknownNavigationPropertyReference";
+  ExtractorErrorCode[
+    (ExtractorErrorCode["InvalidNavigationPropertyReference"] = 10)
+  ] = "InvalidNavigationPropertyReference";
+  ExtractorErrorCode[
+    (ExtractorErrorCode["MissingNavigationPropertyReference"] = 11)
+  ] = "MissingNavigationPropertyReference";
+  ExtractorErrorCode[(ExtractorErrorCode["MissingManyToManyUniqueId"] = 12)] =
+    "MissingManyToManyUniqueId";
+  ExtractorErrorCode[(ExtractorErrorCode["MissingPrimaryKey"] = 13)] =
+    "MissingPrimaryKey";
+  ExtractorErrorCode[(ExtractorErrorCode["MissingDatabaseBinding"] = 14)] =
+    "MissingDatabaseBinding";
+  ExtractorErrorCode[(ExtractorErrorCode["TooManyWranglerEnvs"] = 15)] =
+    "TooManyWranglerEnvs";
+  ExtractorErrorCode[(ExtractorErrorCode["MissingFile"] = 16)] = "MissingFile";
+  ExtractorErrorCode[(ExtractorErrorCode["InvalidServiceAttribute"] = 17)] =
+    "InvalidServiceAttribute";
+})(ExtractorErrorCode || (ExtractorErrorCode = {}));
+const errorInfoMap = {
+  [ExtractorErrorCode.MissingExport]: {
+    description: "All Cloesce types must be exported.",
+    suggestion: "Add `export` to the class definition.",
+  },
+  [ExtractorErrorCode.AppMissingDefaultExport]: {
+    description: "app.cloesce.ts does not export a CloesceApp by default",
+    suggestion: "Export an instantiated CloesceApp in app.cloesce.ts",
+  },
+  [ExtractorErrorCode.UnknownType]: {
+    description: "Encountered an unknown or unsupported type",
+    suggestion: "Refer to the documentation on valid Cloesce TS types",
+  },
+  [ExtractorErrorCode.InvalidPartialType]: {
+    description: "Partial types must only contain a model or plain old object",
+    suggestion: "Refer to the documentation on valid Cloesce TS types",
+  },
+  [ExtractorErrorCode.MultipleGenericType]: {
+    description: "Cloesce does not yet support types with multiple generics",
+    suggestion:
+      "Simplify your type to use only a single generic parameter, ie Foo<T>",
+  },
+  [ExtractorErrorCode.InvalidDataSourceDefinition]: {
+    description:
+      "Data Sources must be explicitly typed as a static Include Tree",
+    suggestion:
+      "Declare your data source as `static readonly _: IncludeTree<Model>`",
+  },
+  [ExtractorErrorCode.InvalidIncludeTree]: {
+    description: "Invalid Include Tree",
+    suggestion:
+      "Include trees must only contain references to a model's navigation properties.",
+  },
+  [ExtractorErrorCode.InvalidAttributeModifier]: {
+    description:
+      "Attributes can only be public on a Model, Plain Old Object or Wrangler Environment",
+    suggestion: "Change the attribute modifier to just `public`",
+  },
+  [ExtractorErrorCode.InvalidApiMethodModifier]: {
+    description:
+      "Model methods must be public if they are decorated as GET, POST, PUT, PATCH",
+    suggestion: "Change the method modifier to just `public`",
+  },
+  [ExtractorErrorCode.UnknownNavigationPropertyReference]: {
+    description: "Unknown Navigation Property Reference",
+    suggestion:
+      "Verify that the navigation property reference model exists, or create a model.",
+  },
+  [ExtractorErrorCode.InvalidNavigationPropertyReference]: {
+    description: "Invalid Navigation Property Reference",
+    suggestion: "Ensure the navigation property points to a valid model field",
+  },
+  [ExtractorErrorCode.MissingNavigationPropertyReference]: {
+    description: "Missing Navigation Property Reference",
+    suggestion:
+      "Navigation properties require a foreign key model attribute reference",
+  },
+  [ExtractorErrorCode.MissingManyToManyUniqueId]: {
+    description: "Missing unique id on Many to Many navigation property",
+    suggestion:
+      "Define a unique identifier field for the Many-to-Many relationship",
+  },
+  [ExtractorErrorCode.MissingPrimaryKey]: {
+    description: "Missing primary key on a model",
+    suggestion: "Add a primary key field to your model (e.g., `id: number`)",
+  },
+  [ExtractorErrorCode.MissingDatabaseBinding]: {
+    description: "Missing a database binding in the WranglerEnv definition",
+    suggestion: "Add a `D1Database` to your WranglerEnv",
+  },
+  [ExtractorErrorCode.TooManyWranglerEnvs]: {
+    description: "Too many wrangler environments defined in the project",
+    suggestion: "Consolidate or remove unused @WranglerEnv's",
+  },
+  [ExtractorErrorCode.MissingFile]: {
+    description: "A specified input file could not be found",
+    suggestion: "Verify the input file path is correct",
+  },
+  [ExtractorErrorCode.InvalidServiceAttribute]: {
+    description:
+      "Services must contain only dependency injected instances as attributes.",
+    suggestion: "Remove the attribute.",
+  },
+};
+export function getErrorInfo(code) {
+  return errorInfoMap[code];
+}
+export class ExtractorError {
+  code;
+  context;
+  snippet;
+  constructor(code) {
+    this.code = code;
+  }
+  addContext(fn) {
+    this.context = fn(this.context ?? "");
+  }
+}

package/dist/extractor/extract.d.ts

@@ -1,17 +1,64 @@
-import { Project, Type, SourceFile, MethodDeclaration, ClassDeclaration, Expression } from "ts-morph";
-import { CidlIncludeTree, CloesceAst, CidlType, Either, HttpVerb, Model, ModelMethod, WranglerEnv, ExtractorError, PlainOldObject } from "../common.js";
+import {
+  Project,
+  Type,
+  SourceFile,
+  MethodDeclaration,
+  ClassDeclaration,
+  Expression,
+} from "ts-morph";
+import {
+  CidlIncludeTree,
+  CloesceAst,
+  CidlType,
+  HttpVerb,
+  Model,
+  ApiMethod,
+  WranglerEnv,
+  PlainOldObject,
+  Service,
+} from "../ast.js";
+import { ExtractorError } from "./err.js";
+import { Either } from "../ui/common.js";
 export declare class CidlExtractor {
-    projectName: string;
-    version: string;
-    constructor(projectName: string, version: string);
-    extract(project: Project): Either<ExtractorError, CloesceAst>;
-    static app(sourceFile: SourceFile): Either<ExtractorError, string>;
-    static model(classDecl: ClassDeclaration, sourceFile: SourceFile): Either<ExtractorError, Model>;
-    static poo(classDecl: ClassDeclaration, sourceFile: SourceFile): Either<ExtractorError, PlainOldObject>;
-    static env(classDecl: ClassDeclaration, sourceFile: SourceFile): Either<ExtractorError, WranglerEnv>;
-    private static readonly primTypeMap;
-    static cidlType(type: Type, inject?: boolean): Either<ExtractorError, CidlType>;
-    static includeTree(expr: Expression | undefined, currentClass: ClassDeclaration, sf: SourceFile): Either<ExtractorError, CidlIncludeTree>;
-    static method(modelName: string, method: MethodDeclaration, httpVerb: HttpVerb): Either<ExtractorError, ModelMethod>;
+  projectName: string;
+  version: string;
+  constructor(projectName: string, version: string);
+  extract(project: Project): Either<ExtractorError, CloesceAst>;
+  static app(sourceFile: SourceFile): Either<ExtractorError, string>;
+  static model(
+    classDecl: ClassDeclaration,
+    sourceFile: SourceFile,
+  ): Either<ExtractorError, Model>;
+  static modelMethod(
+    modelName: string,
+    method: MethodDeclaration,
+    verb: HttpVerb,
+  ): Either<ExtractorError, ApiMethod>;
+  static service(
+    classDecl: ClassDeclaration,
+    sourceFile: SourceFile,
+  ): Either<ExtractorError, Service>;
+  static serviceMethod(
+    method: MethodDeclaration,
+    verb: HttpVerb,
+  ): Either<ExtractorError, ApiMethod>;
+  static poo(
+    classDecl: ClassDeclaration,
+    sourceFile: SourceFile,
+  ): Either<ExtractorError, PlainOldObject>;
+  static env(
+    classDecl: ClassDeclaration,
+    sourceFile: SourceFile,
+  ): Either<ExtractorError, WranglerEnv>;
+  private static readonly primTypeMap;
+  static cidlType(
+    type: Type,
+    inject?: boolean,
+  ): Either<ExtractorError, CidlType>;
+  static includeTree(
+    expr: Expression | undefined,
+    currentClass: ClassDeclaration,
+    sf: SourceFile,
+  ): Either<ExtractorError, CidlIncludeTree>;
 }
-//# sourceMappingURL=extract.d.ts.map
+//# sourceMappingURL=extract.d.ts.map

package/dist/extractor/extract.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"extract.d.ts","sourceRoot":"","sources":["../../src/extractor/extract.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,OAAO,EACP,IAAI,EACJ,UAAU,EAEV,iBAAiB,EAEjB,gBAAgB,EAEhB,UAAU,EAEX,MAAM,UAAU,CAAC;AAElB,OAAO,EACL,eAAe,EACf,UAAU,EACV,QAAQ,EAER,MAAM,EACN,QAAQ,EACR,KAAK,EAEL,WAAW,EAGX,WAAW,EACX,cAAc,EAEd,cAAc,EAEf,MAAM,cAAc,CAAC;AAuBtB,qBAAa,aAAa;IAEf,WAAW,EAAE,MAAM;IACnB,OAAO,EAAE,MAAM;gBADf,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM;IAGxB,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAAC,cAAc,EAAE,UAAU,CAAC;IA8F7D,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC;IA8BlE,MAAM,CAAC,KAAK,CACV,SAAS,EAAE,gBAAgB,EAC3B,UAAU,EAAE,UAAU,GACrB,MAAM,CAAC,cAAc,EAAE,KAAK,CAAC;IAgQhC,MAAM,CAAC,GAAG,CACR,SAAS,EAAE,gBAAgB,EAC3B,UAAU,EAAE,UAAU,GACrB,MAAM,CAAC,cAAc,EAAE,cAAc,CAAC;IAmCzC,MAAM,CAAC,GAAG,CACR,SAAS,EAAE,gBAAgB,EAC3B,UAAU,EAAE,UAAU,GACrB,MAAM,CAAC,cAAc,EAAE,WAAW,CAAC;IAuCtC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CASjC;IAEF,MAAM,CAAC,QAAQ,CACb,IAAI,EAAE,IAAI,EACV,MAAM,GAAE,OAAe,GACtB,MAAM,CAAC,cAAc,EAAE,QAAQ,CAAC;IAkJnC,MAAM,CAAC,WAAW,CAChB,IAAI,EAAE,UAAU,GAAG,SAAS,EAC5B,YAAY,EAAE,gBAAgB,EAC9B,EAAE,EAAE,UAAU,GACb,MAAM,CAAC,cAAc,EAAE,eAAe,CAAC;IAiF1C,MAAM,CAAC,MAAM,CACX,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,iBAAiB,EACzB,QAAQ,EAAE,QAAQ,GACjB,MAAM,CAAC,cAAc,EAAE,WAAW,CAAC;CA0EvC"}
+{"version":3,"file":"extract.d.ts","sourceRoot":"","sources":["../../src/extractor/extract.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,OAAO,EACP,IAAI,EACJ,UAAU,EAEV,iBAAiB,EAEjB,gBAAgB,EAEhB,UAAU,EAEX,MAAM,UAAU,CAAC;AAElB,OAAO,EACL,eAAe,EACf,UAAU,EACV,QAAQ,EAER,QAAQ,EACR,KAAK,EAEL,SAAS,EAGT,WAAW,EACX,cAAc,EAEd,OAAO,EAER,MAAM,WAAW,CAAC;AAEnB,OAAO,EAAE,cAAc,EAAsB,MAAM,UAAU,CAAC;AAC9D,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAuBzC,qBAAa,aAAa;IAEf,WAAW,EAAE,MAAM;IACnB,OAAO,EAAE,MAAM;gBADf,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM;IAGxB,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAAC,cAAc,EAAE,UAAU,CAAC;IA4G7D,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC;IA8BlE,MAAM,CAAC,KAAK,CACV,SAAS,EAAE,gBAAgB,EAC3B,UAAU,EAAE,UAAU,GACrB,MAAM,CAAC,cAAc,EAAE,KAAK,CAAC;IAgQhC,MAAM,CAAC,WAAW,CAChB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,iBAAiB,EACzB,IAAI,EAAE,QAAQ,GACb,MAAM,CAAC,cAAc,EAAE,SAAS,CAAC;IA6EpC,MAAM,CAAC,OAAO,CACZ,SAAS,EAAE,gBAAgB,EAC3B,UAAU,EAAE,UAAU,GACrB,MAAM,CAAC,cAAc,EAAE,OAAO,CAAC;IA+DlC,MAAM,CAAC,aAAa,CAClB,MAAM,EAAE,iBAAiB,EACzB,IAAI,EAAE,QAAQ,GACb,MAAM,CAAC,cAAc,EAAE,SAAS,CAAC;IAiEpC,MAAM,CAAC,GAAG,CACR,SAAS,EAAE,gBAAgB,EAC3B,UAAU,EAAE,UAAU,GACrB,MAAM,CAAC,cAAc,EAAE,cAAc,CAAC;IAmCzC,MAAM,CAAC,GAAG,CACR,SAAS,EAAE,gBAAgB,EAC3B,UAAU,EAAE,UAAU,GACrB,MAAM,CAAC,cAAc,EAAE,WAAW,CAAC;IAuCtC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAWjC;IAEF,MAAM,CAAC,QAAQ,CACb,IAAI,EAAE,IAAI,EACV,MAAM,GAAE,OAAe,GACtB,MAAM,CAAC,cAAc,EAAE,QAAQ,CAAC;IAmJnC,MAAM,CAAC,WAAW,CAChB,IAAI,EAAE,UAAU,GAAG,SAAS,EAC5B,YAAY,EAAE,gBAAgB,EAC9B,EAAE,EAAE,UAAU,GACb,MAAM,CAAC,cAAc,EAAE,eAAe,CAAC;CAiF3C"}