firebase-contract 0.1.0-rc.10 → 0.1.0-rc.11

package/dist/lib/_internal/generators/api/api-dto-generator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api-dto-generator.d.ts","sourceRoot":"","sources":["../../../../../src/lib/_internal/generators/api/api-dto-generator.ts"],"names":[],"mappings":"AAGA,OAAO,EAAiB,SAAS,EAAgC,MAAM,iBAAiB,CAAA;AAoHxF,eAAO,MAAM,qBAAqB,QAAO,SAuBvC,CAAA"}
+{"version":3,"file":"api-dto-generator.d.ts","sourceRoot":"","sources":["../../../../../src/lib/_internal/generators/api/api-dto-generator.ts"],"names":[],"mappings":"AAGA,OAAO,EAAiB,SAAS,EAAgC,MAAM,iBAAiB,CAAA;AA8GxF,eAAO,MAAM,qBAAqB,QAAO,SAuBvC,CAAA"}

package/dist/lib/_internal/generators/api/api-dto-generator.js

@@ -3,6 +3,7 @@ import { pascalCase, singleQuote } from '../support/naming.js';
 import { isRelation, relationFkName } from '../support/relations.js';
 import { selectApis } from '../generator.js';
 import { headerBlocks } from '../support/header.js';
+import { jsdoc } from '../support/jsdoc.js';
 import { emitApiFiles, resolveOutput } from '../support/templates.js';
 const SCALAR_TS = {
     string: 'string',
@@ -96,14 +97,6 @@ const decoratorsFor = (ir, field, used) => {
     }
     return out;
 };
-const jsdoc = (description, indent) => {
-    if (!description)
-        return '';
-    const lines = description.split('\n');
-    if (lines.length === 1)
-        return `${indent}/** ${lines[0]} */\n`;
-    return `${indent}/**\n${lines.map(line => `${indent} * ${line}`.trimEnd()).join('\n')}\n${indent} */\n`;
-};
 const renderDto = (ir, api, used) => {
     const fields = payloadFields(ir, api.request);
     const className = `${pascalCase(api.name)}Dto`;

package/dist/lib/_internal/generators/api/api-types-generator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api-types-generator.d.ts","sourceRoot":"","sources":["../../../../../src/lib/_internal/generators/api/api-types-generator.ts"],"names":[],"mappings":"AAGA,OAAO,EAAiB,SAAS,EAAgC,MAAM,iBAAiB,CAAA;AAsFxF,eAAO,MAAM,uBAAuB,QAAO,SA+BzC,CAAA"}
+{"version":3,"file":"api-types-generator.d.ts","sourceRoot":"","sources":["../../../../../src/lib/_internal/generators/api/api-types-generator.ts"],"names":[],"mappings":"AAGA,OAAO,EAAiB,SAAS,EAAgC,MAAM,iBAAiB,CAAA;AA4FxF,eAAO,MAAM,uBAAuB,QAAO,SA+BzC,CAAA"}

package/dist/lib/_internal/generators/api/api-types-generator.js

@@ -2,6 +2,7 @@ import { pascalCase } from '../support/naming.js';
 import { isRelation, relationFkName, relationFkType } from '../support/relations.js';
 import { selectApis } from '../generator.js';
 import { headerBlocks } from '../support/header.js';
+import { jsdoc } from '../support/jsdoc.js';
 import { emitApiFiles, resolveOutput } from '../support/templates.js';
 const SCALAR_TS = {
     string: 'string',
@@ -34,8 +35,7 @@ const renderField = (ir, field) => {
     const name = isRelation(field) ? relationFkName(field) : field.name;
     const optional = field.optional ? '?' : '';
     const nullable = field.nullable ? ' | null' : '';
-    const doc = field.description ? `  /** ${field.description} */\n` : '';
-    return `${doc}  ${name}${optional}: ${renderFieldTsType(ir, field)}${nullable}`;
+    return `${jsdoc(field.description, '  ')}  ${name}${optional}: ${renderFieldTsType(ir, field)}${nullable}`;
 };
 const renderPayloadType = (ir, payload, typeName) => {
     if (payload.isVoid) {
@@ -74,9 +74,15 @@ const apiComment = (api) => {
     const bits = [`kind: ${api.kind}`];
     if (api.method)
         bits.push(`method: ${api.method}`);
-    if (api.description)
-        bits.unshift(api.description);
-    return `// ${api.name} — ${bits.join(' | ')}`;
+    const description = api.description?.split('\n') ?? [];
+    // Single-line descriptions stay inline; multi-line ones get their own
+    // comment lines so literal-block yml descriptions survive verbatim.
+    if (description.length <= 1) {
+        if (description[0])
+            bits.unshift(description[0]);
+        return `// ${api.name} — ${bits.join(' | ')}`;
+    }
+    return [`// ${api.name} — ${bits.join(' | ')}`, ...description.map(line => `// ${line}`.trimEnd())].join('\n');
 };
 /**
  * Generates request/response TypeScript types for each API endpoint. A payload

package/dist/lib/_internal/generators/api/task-payload-generator.js

@@ -3,6 +3,7 @@ import { constantCase, pascalCase, singleQuote } from '../support/naming.js';
 import { isRelation, relationFkName, relationFkType } from '../support/relations.js';
 import { selectApis } from '../generator.js';
 import { headerBlocks } from '../support/header.js';
+import { jsdoc } from '../support/jsdoc.js';
 import { emitApiFiles, resolveOutput } from '../support/templates.js';
 const SCALAR_TS = {
     string: 'string',
@@ -30,13 +31,12 @@ const fieldTs = (ir, field) => {
 };
 const renderMember = (ir, field) => {
     const name = isRelation(field) ? relationFkName(field) : field.name;
-    const doc = field.description ? `  /** ${field.description} */\n` : '';
     const nullable = field.nullable ? ' | null' : '';
-    return `${doc}  ${name}${field.optional ? '?' : ''}: ${fieldTs(ir, field)}${nullable}`;
+    return `${jsdoc(field.description, '  ')}  ${name}${field.optional ? '?' : ''}: ${fieldTs(ir, field)}${nullable}`;
 };
 const payloadFields = (ir, payload) => payload.model ? (findModel(ir, payload.model)?.fields ?? []) : payload.fields;
 const renderEnvelope = (env) => {
-    const doc = env.description ? `/** ${env.description} */\n` : '';
+    const doc = jsdoc(env.description, '');
     const members = env.fields.map(field => `  ${field.name}${field.optional ? '?' : ''}: ${SCALAR_TS[field.type.kind === 'scalar' ? field.type.name : 'string']}`).join('\n');
     return `${doc}export type ${env.name}<T> = T & {\n${members}\n}`;
 };

package/dist/lib/_internal/generators/support/jsdoc.d.ts

@@ -0,0 +1,3 @@
+/** Render a JSDoc block for a possibly multi-line description ('' when absent). */
+export declare const jsdoc: (description: string | undefined, indent: string) => string;
+//# sourceMappingURL=jsdoc.d.ts.map

package/dist/lib/_internal/generators/support/jsdoc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsdoc.d.ts","sourceRoot":"","sources":["../../../../../src/lib/_internal/generators/support/jsdoc.ts"],"names":[],"mappings":"AAAA,mFAAmF;AACnF,eAAO,MAAM,KAAK,GAAI,aAAa,MAAM,GAAG,SAAS,EAAE,QAAQ,MAAM,KAAG,MAKvE,CAAA"}

package/dist/lib/_internal/generators/support/jsdoc.js

@@ -0,0 +1,9 @@
+/** Render a JSDoc block for a possibly multi-line description ('' when absent). */
+export const jsdoc = (description, indent) => {
+    if (!description)
+        return '';
+    const lines = description.split('\n');
+    if (lines.length === 1)
+        return `${indent}/** ${lines[0]} */\n`;
+    return `${indent}/**\n${lines.map(line => `${indent} * ${line}`.trimEnd()).join('\n')}\n${indent} */\n`;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-contract",
-  "version": "0.1.0-rc.10",
+  "version": "0.1.0-rc.11",
   "type": "module",
   "bin": {
     "firebase-contract": "./dist/lib/cli/index.js",