@pikku/openapi-parser 0.12.16 → 0.12.17

package/CHANGELOG.md

@@ -1,5 +1,44 @@
 # @pikku/openapi-parser
 
+## 0.12.17
+
+### Patch Changes
+
+- a7b26c5: rename the inspected declarations to `define*`: `wireScope` → `defineScope`, `wireSecret` → `defineSecret`, `wireVariable` → `defineVariable`, `wireCredential` → `defineCredential`
+
+  `wire*` meant two unrelated things. A transport wiring attaches a function to
+  something that can invoke it — `wireHTTP`, `wireChannel`, `wireScheduler`,
+  `wireQueueWorker` and the rest — and the thing it wires runs. These four wire
+  nothing: they are no-ops that exist only so the call typechecks, they are
+  tree-shaken out of the build, and their whole job is to be found by the
+  inspector's AST pass and turned into a type union. One word for both left the
+  declaration reading like a registration with a runtime.
+
+  So the vocabulary splits: **`wire*` is a transport, `define*` is an inspected
+  declaration.**
+
+  ```ts
+  import { defineScope } from '@pikku/core/scope'
+  import { defineSecret } from '@pikku/core/secret'
+  import { defineVariable } from '@pikku/core/variable'
+  import { defineCredential } from '@pikku/core/credential'
+
+  defineScope({ admin: { scopes: { invoices: { scopes: { create: {} } } } } })
+  ```
+
+  **Breaking:** no alias is kept. Rename the four call sites; the module subpaths
+  (`@pikku/core/scope`, `/secret`, `/variable`) are unchanged.
+
+  The inspector matches these by identifier text, so a stale `wire*` call is not a
+  type error — it is silently not extracted, and the generated union comes back
+  empty. That fails as "this scope isn't declared" on code that was fine a moment
+  ago, nowhere near the declaration. Grep for the old names rather than trusting a
+  clean build.
+
+  An addon published with `.pikku` output generated before this release re-exports
+  `wireSecret` from `@pikku/core/secret` and will not typecheck against this core
+  until it is rebuilt and republished.
+
 ## 0.12.16
 
 ### Patch Changes

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 - present Yasser Fadl and Pikku contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,25 @@
+# @pikku/openapi-parser
+
+Parses OpenAPI specs into a normalised shape and generates Pikku addon code
+from them — operations, parameters, error responses and security schemes.
+
+## Install
+
+```bash
+npm install -D @pikku/openapi-parser
+```
+
+## Usage
+
+```typescript
+import { parseOpenAPISpec, computeContractHash } from '@pikku/openapi-parser'
+
+const spec = await parseOpenAPISpec(specPath)
+const hash = computeContractHash(spec)
+```
+
+The contract hash lets generated addons detect when an upstream spec changed.
+
+## Docs
+
+https://pikku.dev/docs

package/dist/codegen.js

@@ -1184,8 +1184,8 @@ function generateCredentialFile(spec, vars) {
         : ['read', 'write'];
     const lines = [];
     lines.push("import { z } from 'zod'");
-    lines.push("import { wireCredential } from '@pikku/core/credential'");
-    lines.push("import { wireSecret } from '@pikku/core/secret'");
+    lines.push("import { defineCredential } from '@pikku/core/credential'");
+    lines.push("import { defineSecret } from '@pikku/core/secret'");
     lines.push('');
     lines.push(`export const ${camelName}TokenSchema = z.object({`);
     lines.push('  accessToken: z.string(),');
@@ -1204,7 +1204,7 @@ function generateCredentialFile(spec, vars) {
     }
     // oauth2 must stay an inline object literal: the inspector reads it via AST
     // (add-credential.ts) and silently drops a config behind an identifier.
-    lines.push('wireCredential({');
+    lines.push('defineCredential({');
     lines.push(`  name: '${camelName}',`);
     lines.push(`  displayName: '${displayName}',`);
     lines.push(`  description: '${description}',`);
@@ -1219,7 +1219,7 @@ function generateCredentialFile(spec, vars) {
     lines.push('  },');
     lines.push('})');
     lines.push('');
-    lines.push('wireSecret({');
+    lines.push('defineSecret({');
     lines.push(`  name: '${camelName}OAuthApp',`);
     lines.push(`  displayName: '${displayName} OAuth App',`);
     lines.push(`  description: 'OAuth2 app credentials for ${displayName}',`);
@@ -1236,7 +1236,7 @@ function generateVariableFile(spec, vars) {
     const defaultUrl = serverUrls[0];
     const lines = [];
     lines.push("import { z } from 'zod'");
-    lines.push("import { wireVariable } from '@pikku/core/variable'");
+    lines.push("import { defineVariable } from '@pikku/core/variable'");
     lines.push('');
     const schemaVarName = `${camelName}BaseUrlSchema`;
     if (serverUrls.length > 0) {
@@ -1247,7 +1247,7 @@ function generateVariableFile(spec, vars) {
         lines.push(`export const ${schemaVarName} = z.string().describe('Base URL for the ${displayName} API')`);
     }
     lines.push('');
-    lines.push(`wireVariable({`);
+    lines.push(`defineVariable({`);
     lines.push(`  name: '${screamingName}_BASE_URL',`);
     lines.push(`  displayName: '${displayName} Base URL',`);
     lines.push(`  description: 'The base URL for the ${displayName} API.',`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pikku/openapi-parser",
-  "version": "0.12.16",
+  "version": "0.12.17",
   "description": "OpenAPI spec parser and code generator for Pikku",
   "author": "yasser.fadl@gmail.com",
   "license": "MIT",

package/src/codegen.ts

@@ -1575,8 +1575,8 @@ function generateCredentialFile(spec: ParsedSpec, vars: AddonVars): string {
 
   const lines: string[] = []
   lines.push("import { z } from 'zod'")
-  lines.push("import { wireCredential } from '@pikku/core/credential'")
-  lines.push("import { wireSecret } from '@pikku/core/secret'")
+  lines.push("import { defineCredential } from '@pikku/core/credential'")
+  lines.push("import { defineSecret } from '@pikku/core/secret'")
   lines.push('')
   lines.push(`export const ${camelName}TokenSchema = z.object({`)
   lines.push('  accessToken: z.string(),')
@@ -1601,7 +1601,7 @@ function generateCredentialFile(spec: ParsedSpec, vars: AddonVars): string {
 
   // oauth2 must stay an inline object literal: the inspector reads it via AST
   // (add-credential.ts) and silently drops a config behind an identifier.
-  lines.push('wireCredential({')
+  lines.push('defineCredential({')
   lines.push(`  name: '${camelName}',`)
   lines.push(`  displayName: '${displayName}',`)
   lines.push(`  description: '${description}',`)
@@ -1620,7 +1620,7 @@ function generateCredentialFile(spec: ParsedSpec, vars: AddonVars): string {
   lines.push('  },')
   lines.push('})')
   lines.push('')
-  lines.push('wireSecret({')
+  lines.push('defineSecret({')
   lines.push(`  name: '${camelName}OAuthApp',`)
   lines.push(`  displayName: '${displayName} OAuth App',`)
   lines.push(`  description: 'OAuth2 app credentials for ${displayName}',`)
@@ -1640,7 +1640,7 @@ function generateVariableFile(spec: ParsedSpec, vars: AddonVars): string {
 
   const lines: string[] = []
   lines.push("import { z } from 'zod'")
-  lines.push("import { wireVariable } from '@pikku/core/variable'")
+  lines.push("import { defineVariable } from '@pikku/core/variable'")
   lines.push('')
 
   const schemaVarName = `${camelName}BaseUrlSchema`
@@ -1657,7 +1657,7 @@ function generateVariableFile(spec: ParsedSpec, vars: AddonVars): string {
   }
 
   lines.push('')
-  lines.push(`wireVariable({`)
+  lines.push(`defineVariable({`)
   lines.push(`  name: '${screamingName}_BASE_URL',`)
   lines.push(`  displayName: '${displayName} Base URL',`)
   lines.push(`  description: 'The base URL for the ${displayName} API.',`)