@feathersjs/cli 4.6.2 → 5.0.0-pre.24

package/lib/service/index.js

@@ -0,0 +1,84 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generate = void 0;
+const lodash_1 = __importDefault(require("lodash"));
+const pinion_1 = require("@feathershq/pinion");
+const commons_1 = require("../commons");
+const generate = (ctx) => (0, pinion_1.generator)(ctx)
+    .then((0, pinion_1.prompt)(({ name, path, type, authentication, isEntityService }) => [
+    {
+        name: 'name',
+        type: 'input',
+        when: !name,
+        message: 'What is the name of your service?'
+    },
+    {
+        name: 'path',
+        type: 'input',
+        when: !path,
+        message: 'Which path should the service be registered on?',
+        default: (answers) => `${lodash_1.default.kebabCase(answers.name)}`
+    },
+    {
+        name: 'authentication',
+        type: 'confirm',
+        when: authentication === undefined && !isEntityService,
+        message: 'Does this service require authentication?'
+    },
+    {
+        name: 'type',
+        type: 'list',
+        when: !type,
+        message: 'What kind of service is it?',
+        default: (0, commons_1.getDatabaseAdapter)(ctx.feathers.database),
+        choices: [
+            {
+                value: 'knex',
+                name: 'SQL'
+            },
+            {
+                value: 'mongodb',
+                name: 'MongoDB'
+            },
+            {
+                value: 'custom',
+                name: 'A custom service'
+            }
+        ]
+    }
+]))
+    .then(async (ctx) => {
+    const { name, path, type } = ctx;
+    const kebabName = lodash_1.default.kebabCase(name);
+    const camelName = lodash_1.default.camelCase(name);
+    const upperName = lodash_1.default.upperFirst(camelName);
+    const className = `${upperName}Service`;
+    const pathElements = path.split('/').filter((el) => el !== '');
+    const relative = pathElements.map(() => '..').join('/');
+    const folder = lodash_1.default.initial(pathElements);
+    const fileName = lodash_1.default.last(pathElements);
+    const schemaPath = ['schemas', ...folder, `${fileName}.schema`].join('/');
+    const resolverPath = ['resolvers', ...folder, `${fileName}.resolver`].join('/');
+    return {
+        name,
+        type,
+        path,
+        folder,
+        fileName,
+        upperName,
+        className,
+        kebabName,
+        camelName,
+        relative,
+        resolverPath,
+        schemaPath,
+        ...ctx
+    };
+})
+    .then((0, pinion_1.runGenerators)(__dirname, 'templates'))
+    .then((0, pinion_1.runGenerator)(__dirname, 'type', ({ type }) => `${type}.tpl`));
+exports.generate = generate;
+//# sourceMappingURL=index.js.map

package/lib/service/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/service/index.ts"],"names":[],"mappings":";;;;;;AAAA,oDAAsB;AACtB,+CAAmF;AAEnF,wCAAoE;AAmE7D,MAAM,QAAQ,GAAG,CAAC,GAA8B,EAAE,EAAE,CACzD,IAAA,kBAAS,EAAC,GAAG,CAAC;KACX,IAAI,CACH,IAAA,eAAM,EACJ,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,cAAc,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC;IACzD;QACE,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,OAAO;QACb,IAAI,EAAE,CAAC,IAAI;QACX,OAAO,EAAE,mCAAmC;KAC7C;IACD;QACE,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,OAAO;QACb,IAAI,EAAE,CAAC,IAAI;QACX,OAAO,EAAE,iDAAiD;QAC1D,OAAO,EAAE,CAAC,OAAkC,EAAE,EAAE,CAAC,GAAG,gBAAC,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;KAChF;IACD;QACE,IAAI,EAAE,gBAAgB;QACtB,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,cAAc,KAAK,SAAS,IAAI,CAAC,eAAe;QACtD,OAAO,EAAE,2CAA2C;KACrD;IACD;QACE,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,CAAC,IAAI;QACX,OAAO,EAAE,6BAA6B;QACtC,OAAO,EAAE,IAAA,4BAAkB,EAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAClD,OAAO,EAAE;YACP;gBACE,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,KAAK;aACZ;YACD;gBACE,KAAK,EAAE,SAAS;gBAChB,IAAI,EAAE,SAAS;aAChB;YACD;gBACE,KAAK,EAAE,QAAQ;gBACf,IAAI,EAAE,kBAAkB;aACzB;SACF;KACF;CACF,CACF,CACF;KACA,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;IAClB,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,GAAG,CAAA;IAChC,MAAM,SAAS,GAAG,gBAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;IACnC,MAAM,SAAS,GAAG,gBAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;IACnC,MAAM,SAAS,GAAG,gBAAC,CAAC,UAAU,CAAC,SAAS,CAAC,CAAA;IACzC,MAAM,SAAS,GAAG,GAAG,SAAS,SAAS,CAAA;IAEvC,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,CAAA;IAC9D,MAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IACvD,MAAM,MAAM,GAAG,gBAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;IACtC,MAAM,QAAQ,GAAG,gBAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;IACrC,MAAM,UAAU,GAAG,CAAC,SAAS,EAAE,GAAG,MAAM,EAAE,GAAG,QAAQ,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IACzE,MAAM,YAAY,GAAG,CAAC,WAAW,EAAE,GAAG,MAAM,EAAE,GAAG,QAAQ,WAAW,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAE/E,OAAO;QACL,IAAI;QACJ,IAAI;QACJ,IAAI;QACJ,MAAM;QACN,QAAQ;QACR,SAAS;QACT,SAAS;QACT,SAAS;QACT,SAAS;QACT,QAAQ;QACR,YAAY;QACZ,UAAU;QACV,GAAG,GAAG;KACP,CAAA;AACH,CAAC,CAAC;KACD,IAAI,CAAC,IAAA,sBAAa,EAA0B,SAAS,EAAE,WAAW,CAAC,CAAC;KACpE,IAAI,CAAC,IAAA,qBAAY,EAA0B,SAAS,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,GAAG,IAAI,MAAM,CAAC,CAAC,CAAA;AA/EnF,QAAA,QAAQ,YA+E2E"}

package/lib/service/index.ts

@@ -0,0 +1,150 @@
+import _ from 'lodash'
+import { generator, runGenerator, runGenerators, prompt } from '@feathershq/pinion'
+
+import { FeathersBaseContext, getDatabaseAdapter } from '../commons'
+
+export interface ServiceGeneratorContext extends FeathersBaseContext {
+  /**
+   * The chosen service name
+   */
+  name: string
+  /**
+   * The path the service is registered on
+   */
+  path: string
+  /**
+   * The list of subfolders this service is in
+   */
+  folder: string[]
+  /**
+   * The `camelCase` service name starting with a lowercase letter
+   */
+  camelName: string
+  /**
+   * The `CamelCase` service name starting with an uppercase letter
+   */
+  upperName: string
+  /**
+   * The service class name combined as `CamelCaseService`
+   */
+  className: string
+  /**
+   * A kebab-cased (filename friendly) version of the service name
+   */
+  kebabName: string
+  /**
+   * The actual filename (the last element of the path)
+   */
+  fileName: string
+  /**
+   * Indicates how many file paths we should go up to import other things (e.g. `../../`)
+   */
+  relative: string
+  /**
+   * The chosen service type
+   */
+  type: 'knex' | 'mongodb' | 'custom'
+  /**
+   * Wether this service uses authentication
+   */
+  authentication: boolean
+  /**
+   * Set to true if this service is for an authentication entity
+   */
+  isEntityService?: boolean
+  /**
+   * The name of the schema file
+   */
+  schemaPath: string
+  /**
+   * The name of the resolver file
+   */
+  resolverPath: string
+}
+
+/**
+ * Parameters the generator is called with
+ */
+export type ServiceGeneratorArguments = FeathersBaseContext &
+  Partial<Pick<ServiceGeneratorContext, 'name' | 'path' | 'type' | 'authentication' | 'isEntityService'>>
+
+export const generate = (ctx: ServiceGeneratorArguments) =>
+  generator(ctx)
+    .then(
+      prompt<ServiceGeneratorArguments, ServiceGeneratorContext>(
+        ({ name, path, type, authentication, isEntityService }) => [
+          {
+            name: 'name',
+            type: 'input',
+            when: !name,
+            message: 'What is the name of your service?'
+          },
+          {
+            name: 'path',
+            type: 'input',
+            when: !path,
+            message: 'Which path should the service be registered on?',
+            default: (answers: ServiceGeneratorArguments) => `${_.kebabCase(answers.name)}`
+          },
+          {
+            name: 'authentication',
+            type: 'confirm',
+            when: authentication === undefined && !isEntityService,
+            message: 'Does this service require authentication?'
+          },
+          {
+            name: 'type',
+            type: 'list',
+            when: !type,
+            message: 'What kind of service is it?',
+            default: getDatabaseAdapter(ctx.feathers.database),
+            choices: [
+              {
+                value: 'knex',
+                name: 'SQL'
+              },
+              {
+                value: 'mongodb',
+                name: 'MongoDB'
+              },
+              {
+                value: 'custom',
+                name: 'A custom service'
+              }
+            ]
+          }
+        ]
+      )
+    )
+    .then(async (ctx) => {
+      const { name, path, type } = ctx
+      const kebabName = _.kebabCase(name)
+      const camelName = _.camelCase(name)
+      const upperName = _.upperFirst(camelName)
+      const className = `${upperName}Service`
+
+      const pathElements = path.split('/').filter((el) => el !== '')
+      const relative = pathElements.map(() => '..').join('/')
+      const folder = _.initial(pathElements)
+      const fileName = _.last(pathElements)
+      const schemaPath = ['schemas', ...folder, `${fileName}.schema`].join('/')
+      const resolverPath = ['resolvers', ...folder, `${fileName}.resolver`].join('/')
+
+      return {
+        name,
+        type,
+        path,
+        folder,
+        fileName,
+        upperName,
+        className,
+        kebabName,
+        camelName,
+        relative,
+        resolverPath,
+        schemaPath,
+        ...ctx
+      }
+    })
+    .then(runGenerators<ServiceGeneratorContext>(__dirname, 'templates'))
+    .then(runGenerator<ServiceGeneratorContext>(__dirname, 'type', ({ type }) => `${type}.tpl`))

package/lib/service/templates/client.tpl.d.ts

@@ -0,0 +1,2 @@
+import { ServiceGeneratorContext } from '../index';
+export declare const generate: (ctx: ServiceGeneratorContext) => Promise<ServiceGeneratorContext>;

package/lib/service/templates/client.tpl.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generate = void 0;
+const pinion_1 = require("@feathershq/pinion");
+const schemaImports = ({ upperName, schemaPath }) => `import type {
+  ${upperName}Data,
+  ${upperName}Result,
+  ${upperName}Query,
+} from './${schemaPath}'`;
+const declarationTemplate = ({ path, upperName }) => `  '${path}': Service<${upperName}Data, ${upperName}Result, Params<${upperName}Query>>`;
+const toClientFile = (0, pinion_1.toFile)(({ lib, language }) => [lib, `client.${language}`]);
+const generate = async (ctx) => (0, pinion_1.generator)(ctx)
+    .then((0, pinion_1.when)((ctx) => ctx.language === 'ts', (0, pinion_1.inject)(schemaImports, (0, pinion_1.after)("from '@feathersjs/feathers'"), toClientFile)))
+    .then((0, pinion_1.when)((ctx) => ctx.language === 'ts', (0, pinion_1.inject)(declarationTemplate, (0, pinion_1.after)('export interface ServiceTypes'), toClientFile)));
+exports.generate = generate;
+//# sourceMappingURL=client.tpl.js.map

package/lib/service/templates/client.tpl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.tpl.js","sourceRoot":"","sources":["../../../src/service/templates/client.tpl.ts"],"names":[],"mappings":";;;AAAA,+CAA2E;AAG3E,MAAM,aAAa,GAAG,CAAC,EAAE,SAAS,EAAE,UAAU,EAA2B,EAAE,EAAE,CAAC;IAC1E,SAAS;IACT,SAAS;IACT,SAAS;YACD,UAAU,GAAG,CAAA;AACzB,MAAM,mBAAmB,GAAG,CAAC,EAAE,IAAI,EAAE,SAAS,EAA2B,EAAE,EAAE,CAC3E,MAAM,IAAI,cAAc,SAAS,SAAS,SAAS,kBAAkB,SAAS,SAAS,CAAA;AAEzF,MAAM,YAAY,GAAG,IAAA,eAAM,EAA0B,CAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,UAAU,QAAQ,EAAE,CAAC,CAAC,CAAA;AAEjG,MAAM,QAAQ,GAAG,KAAK,EAAE,GAA4B,EAAE,EAAE,CAC7D,IAAA,kBAAS,EAAC,GAAG,CAAC;KACX,IAAI,CACH,IAAA,aAAI,EACF,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,KAAK,IAAI,EAC9B,IAAA,eAAM,EAAC,aAAa,EAAE,IAAA,cAAK,EAAC,6BAA6B,CAAC,EAAE,YAAY,CAAC,CAC1E,CACF;KACA,IAAI,CACH,IAAA,aAAI,EACF,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,KAAK,IAAI,EAC9B,IAAA,eAAM,EAAC,mBAAmB,EAAE,IAAA,cAAK,EAAC,+BAA+B,CAAC,EAAE,YAAY,CAAC,CAClF,CACF,CAAA;AAbQ,QAAA,QAAQ,YAahB"}

package/lib/service/templates/client.tpl.ts

@@ -0,0 +1,27 @@
+import { generator, inject, toFile, when, after } from '@feathershq/pinion'
+import { ServiceGeneratorContext } from '../index'
+
+const schemaImports = ({ upperName, schemaPath }: ServiceGeneratorContext) => `import type {
+  ${upperName}Data,
+  ${upperName}Result,
+  ${upperName}Query,
+} from './${schemaPath}'`
+const declarationTemplate = ({ path, upperName }: ServiceGeneratorContext) =>
+  `  '${path}': Service<${upperName}Data, ${upperName}Result, Params<${upperName}Query>>`
+
+const toClientFile = toFile<ServiceGeneratorContext>(({ lib, language }) => [lib, `client.${language}`])
+
+export const generate = async (ctx: ServiceGeneratorContext) =>
+  generator(ctx)
+    .then(
+      when(
+        (ctx) => ctx.language === 'ts',
+        inject(schemaImports, after("from '@feathersjs/feathers'"), toClientFile)
+      )
+    )
+    .then(
+      when(
+        (ctx) => ctx.language === 'ts',
+        inject(declarationTemplate, after('export interface ServiceTypes'), toClientFile)
+      )
+    )

package/lib/service/templates/resolver.tpl.d.ts

@@ -0,0 +1,2 @@
+import { ServiceGeneratorContext } from '../index';
+export declare const generate: (ctx: ServiceGeneratorContext) => Promise<ServiceGeneratorContext>;

package/lib/service/templates/resolver.tpl.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generate = void 0;
+const pinion_1 = require("@feathershq/pinion");
+const commons_1 = require("../../commons");
+const template = ({ camelName, upperName, relative, schemaPath }) => `import { resolve } from '@feathersjs/schema'
+import type { HookContext } from '${relative}/declarations'
+
+import type {
+  ${upperName}Data,
+  ${upperName}Patch,
+  ${upperName}Result,
+  ${upperName}Query,
+} from '${relative}/${schemaPath}'
+import {
+  ${camelName}DataSchema,
+  ${camelName}PatchSchema,
+  ${camelName}ResultSchema,
+  ${camelName}QuerySchema
+} from '${relative}/${schemaPath}'
+
+
+// Resolver for the basic data model (e.g. creating new entries)
+export const ${camelName}DataResolver = resolve<${upperName}Data, HookContext>({
+  schema: ${camelName}DataSchema,
+  validate: 'before',
+  properties: {}
+})
+
+
+// Resolver for making partial updates
+export const ${camelName}PatchResolver = resolve<${upperName}Patch, HookContext>({
+  schema: ${camelName}PatchSchema,
+  validate: 'before',
+  properties: {}
+})
+
+
+// Resolver for the data that is being returned
+export const ${camelName}ResultResolver = resolve<${upperName}Result, HookContext>({
+  schema: ${camelName}ResultSchema,
+  validate: false,
+  properties: {}
+})
+
+
+// Resolver for query properties
+export const ${camelName}QueryResolver = resolve<${upperName}Query, HookContext>({
+  schema: ${camelName}QuerySchema,
+  validate: 'before',
+  properties: {}
+})
+
+
+// Export all resolvers in a format that can be used with the resolveAll hook
+export const ${camelName}Resolvers = {
+  result: ${camelName}ResultResolver,
+  data: {
+    create: ${camelName}DataResolver,
+    update: ${camelName}DataResolver,
+    patch: ${camelName}PatchResolver
+  },
+  query: ${camelName}QueryResolver
+}
+`;
+const generate = (ctx) => (0, pinion_1.generator)(ctx).then((0, commons_1.renderSource)(template, (0, pinion_1.toFile)(({ lib, folder, fileName }) => [
+    lib,
+    'resolvers',
+    ...folder,
+    `${fileName}.resolver`
+])));
+exports.generate = generate;
+//# sourceMappingURL=resolver.tpl.js.map

package/lib/service/templates/resolver.tpl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolver.tpl.js","sourceRoot":"","sources":["../../../src/service/templates/resolver.tpl.ts"],"names":[],"mappings":";;;AAAA,+CAAsD;AACtD,2CAA4C;AAG5C,MAAM,QAAQ,GAAG,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAA2B,EAAE,EAAE,CAC3F;oCACkC,QAAQ;;;IAGxC,SAAS;IACT,SAAS;IACT,SAAS;IACT,SAAS;UACH,QAAQ,IAAI,UAAU;;IAE5B,SAAS;IACT,SAAS;IACT,SAAS;IACT,SAAS;UACH,QAAQ,IAAI,UAAU;;;;eAIjB,SAAS,0BAA0B,SAAS;YAC/C,SAAS;;;;;;;eAON,SAAS,2BAA2B,SAAS;YAChD,SAAS;;;;;;;eAON,SAAS,4BAA4B,SAAS;YACjD,SAAS;;;;;;;eAON,SAAS,2BAA2B,SAAS;YAChD,SAAS;;;;;;;eAON,SAAS;YACZ,SAAS;;cAEP,SAAS;cACT,SAAS;aACV,SAAS;;WAEX,SAAS;;CAEnB,CAAA;AAEM,MAAM,QAAQ,GAAG,CAAC,GAA4B,EAAE,EAAE,CACvD,IAAA,kBAAS,EAAC,GAAG,CAAC,CAAC,IAAI,CACjB,IAAA,sBAAY,EACV,QAAQ,EACR,IAAA,eAAM,EAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAA2B,EAAE,EAAE,CAAC;IAC7D,GAAG;IACH,WAAW;IACX,GAAG,MAAM;IACT,GAAG,QAAQ,WAAW;CACvB,CAAC,CACH,CACF,CAAA;AAXU,QAAA,QAAQ,YAWlB"}

package/lib/service/templates/resolver.tpl.ts

@@ -0,0 +1,78 @@
+import { generator, toFile } from '@feathershq/pinion'
+import { renderSource } from '../../commons'
+import { ServiceGeneratorContext } from '../index'
+
+const template = ({ camelName, upperName, relative, schemaPath }: ServiceGeneratorContext) =>
+  `import { resolve } from '@feathersjs/schema'
+import type { HookContext } from '${relative}/declarations'
+
+import type {
+  ${upperName}Data,
+  ${upperName}Patch,
+  ${upperName}Result,
+  ${upperName}Query,
+} from '${relative}/${schemaPath}'
+import {
+  ${camelName}DataSchema,
+  ${camelName}PatchSchema,
+  ${camelName}ResultSchema,
+  ${camelName}QuerySchema
+} from '${relative}/${schemaPath}'
+
+
+// Resolver for the basic data model (e.g. creating new entries)
+export const ${camelName}DataResolver = resolve<${upperName}Data, HookContext>({
+  schema: ${camelName}DataSchema,
+  validate: 'before',
+  properties: {}
+})
+
+
+// Resolver for making partial updates
+export const ${camelName}PatchResolver = resolve<${upperName}Patch, HookContext>({
+  schema: ${camelName}PatchSchema,
+  validate: 'before',
+  properties: {}
+})
+
+
+// Resolver for the data that is being returned
+export const ${camelName}ResultResolver = resolve<${upperName}Result, HookContext>({
+  schema: ${camelName}ResultSchema,
+  validate: false,
+  properties: {}
+})
+
+
+// Resolver for query properties
+export const ${camelName}QueryResolver = resolve<${upperName}Query, HookContext>({
+  schema: ${camelName}QuerySchema,
+  validate: 'before',
+  properties: {}
+})
+
+
+// Export all resolvers in a format that can be used with the resolveAll hook
+export const ${camelName}Resolvers = {
+  result: ${camelName}ResultResolver,
+  data: {
+    create: ${camelName}DataResolver,
+    update: ${camelName}DataResolver,
+    patch: ${camelName}PatchResolver
+  },
+  query: ${camelName}QueryResolver
+}
+`
+
+export const generate = (ctx: ServiceGeneratorContext) =>
+  generator(ctx).then(
+    renderSource(
+      template,
+      toFile(({ lib, folder, fileName }: ServiceGeneratorContext) => [
+        lib,
+        'resolvers',
+        ...folder,
+        `${fileName}.resolver`
+      ])
+    )
+  )

package/lib/service/templates/schema.tpl.d.ts

@@ -0,0 +1,2 @@
+import { ServiceGeneratorContext } from '../index';
+export declare const generate: (ctx: ServiceGeneratorContext) => Promise<ServiceGeneratorContext>;

package/lib/service/templates/schema.tpl.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generate = void 0;
+const pinion_1 = require("@feathershq/pinion");
+const commons_1 = require("../../commons");
+const template = ({ camelName, upperName, type }) => `import { schema, querySyntax } from '@feathersjs/schema'
+import type { Infer } from '@feathersjs/schema'
+
+// Schema for the basic data model (e.g. creating new entries)
+export const ${camelName}DataSchema = schema({
+  $id: '${upperName}Data',
+  type: 'object',
+  additionalProperties: false,
+  required: [ 'text' ],
+  properties: {
+    text: {
+      type: 'string'
+    }
+  }
+} as const)
+
+export type ${upperName}Data = Infer<typeof ${camelName}DataSchema>
+
+
+// Schema for making partial updates
+export const ${camelName}PatchSchema = schema({
+  $id: '${upperName}Patch',
+  type: 'object',
+  additionalProperties: false,
+  required: [],
+  properties: {
+    ...${camelName}DataSchema.properties
+  }
+} as const)
+
+export type ${upperName}Patch = Infer<typeof ${camelName}PatchSchema>
+
+
+// Schema for the data that is being returned
+export const ${camelName}ResultSchema = schema({
+  $id: '${upperName}Result',
+  type: 'object',
+  additionalProperties: false,
+  required: [ ...${camelName}DataSchema.required, '${type === 'mongodb' ? '_id' : 'id'}' ],
+  properties: {
+    ...${camelName}DataSchema.properties,
+    ${type === 'mongodb' ? '_id' : 'id'}: {
+      type: 'string'
+    }
+  }
+} as const)
+
+export type ${upperName}Result = Infer<typeof ${camelName}ResultSchema>
+
+
+// Schema for allowed query properties
+export const ${camelName}QuerySchema = schema({
+  $id: '${upperName}Query',
+  type: 'object',
+  additionalProperties: false,
+  properties: {
+    ...querySyntax(${camelName}ResultSchema.properties)
+  }
+} as const)
+
+export type ${upperName}Query = Infer<typeof ${camelName}QuerySchema>
+`;
+const generate = (ctx) => (0, pinion_1.generator)(ctx).then((0, commons_1.renderSource)(template, (0, pinion_1.toFile)(({ lib, folder, fileName }) => [
+    lib,
+    'schemas',
+    ...folder,
+    `${fileName}.schema`
+])));
+exports.generate = generate;
+//# sourceMappingURL=schema.tpl.js.map

package/lib/service/templates/schema.tpl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.tpl.js","sourceRoot":"","sources":["../../../src/service/templates/schema.tpl.ts"],"names":[],"mappings":";;;AAAA,+CAAsD;AACtD,2CAA4C;AAG5C,MAAM,QAAQ,GAAG,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAA2B,EAAE,EAAE,CAC3E;;;;eAIa,SAAS;UACd,SAAS;;;;;;;;;;;cAWL,SAAS,uBAAuB,SAAS;;;;eAIxC,SAAS;UACd,SAAS;;;;;SAKV,SAAS;;;;cAIJ,SAAS,wBAAwB,SAAS;;;;eAIzC,SAAS;UACd,SAAS;;;mBAGA,SAAS,yBAAyB,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI;;SAE7E,SAAS;MACZ,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI;;;;;;cAMzB,SAAS,yBAAyB,SAAS;;;;eAI1C,SAAS;UACd,SAAS;;;;qBAIE,SAAS;;;;cAIhB,SAAS,wBAAwB,SAAS;CACvD,CAAA;AAEM,MAAM,QAAQ,GAAG,CAAC,GAA4B,EAAE,EAAE,CACvD,IAAA,kBAAS,EAAC,GAAG,CAAC,CAAC,IAAI,CACjB,IAAA,sBAAY,EACV,QAAQ,EACR,IAAA,eAAM,EAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAA2B,EAAE,EAAE,CAAC;IAC7D,GAAG;IACH,SAAS;IACT,GAAG,MAAM;IACT,GAAG,QAAQ,SAAS;CACrB,CAAC,CACH,CACF,CAAA;AAXU,QAAA,QAAQ,YAWlB"}

package/lib/service/templates/schema.tpl.ts

@@ -0,0 +1,80 @@
+import { generator, toFile } from '@feathershq/pinion'
+import { renderSource } from '../../commons'
+import { ServiceGeneratorContext } from '../index'
+
+const template = ({ camelName, upperName, type }: ServiceGeneratorContext) =>
+  `import { schema, querySyntax } from '@feathersjs/schema'
+import type { Infer } from '@feathersjs/schema'
+
+// Schema for the basic data model (e.g. creating new entries)
+export const ${camelName}DataSchema = schema({
+  $id: '${upperName}Data',
+  type: 'object',
+  additionalProperties: false,
+  required: [ 'text' ],
+  properties: {
+    text: {
+      type: 'string'
+    }
+  }
+} as const)
+
+export type ${upperName}Data = Infer<typeof ${camelName}DataSchema>
+
+
+// Schema for making partial updates
+export const ${camelName}PatchSchema = schema({
+  $id: '${upperName}Patch',
+  type: 'object',
+  additionalProperties: false,
+  required: [],
+  properties: {
+    ...${camelName}DataSchema.properties
+  }
+} as const)
+
+export type ${upperName}Patch = Infer<typeof ${camelName}PatchSchema>
+
+
+// Schema for the data that is being returned
+export const ${camelName}ResultSchema = schema({
+  $id: '${upperName}Result',
+  type: 'object',
+  additionalProperties: false,
+  required: [ ...${camelName}DataSchema.required, '${type === 'mongodb' ? '_id' : 'id'}' ],
+  properties: {
+    ...${camelName}DataSchema.properties,
+    ${type === 'mongodb' ? '_id' : 'id'}: {
+      type: 'string'
+    }
+  }
+} as const)
+
+export type ${upperName}Result = Infer<typeof ${camelName}ResultSchema>
+
+
+// Schema for allowed query properties
+export const ${camelName}QuerySchema = schema({
+  $id: '${upperName}Query',
+  type: 'object',
+  additionalProperties: false,
+  properties: {
+    ...querySyntax(${camelName}ResultSchema.properties)
+  }
+} as const)
+
+export type ${upperName}Query = Infer<typeof ${camelName}QuerySchema>
+`
+
+export const generate = (ctx: ServiceGeneratorContext) =>
+  generator(ctx).then(
+    renderSource(
+      template,
+      toFile(({ lib, folder, fileName }: ServiceGeneratorContext) => [
+        lib,
+        'schemas',
+        ...folder,
+        `${fileName}.schema`
+      ])
+    )
+  )

package/lib/service/templates/service.tpl.d.ts

@@ -0,0 +1,2 @@
+import { ServiceGeneratorContext } from '../index';
+export declare const generate: (ctx: ServiceGeneratorContext) => Promise<ServiceGeneratorContext>;