npm - @unispechq/unispec-core - Versions diffs - 0.1.0 → 0.1.1 - Mend

@unispechq/unispec-core 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (31) hide show

package/.github/workflows/npm-publish.yml +74 -74
package/.windsurfrules +138 -138
package/README.md +223 -223
package/package.json +28 -28
package/scripts/release.js +51 -51
package/src/converters/index.ts +120 -120
package/src/diff/index.ts +235 -235
package/src/index.ts +6 -6
package/src/loader/index.ts +25 -25
package/src/normalizer/index.ts +156 -156
package/src/types/index.ts +67 -67
package/src/validator/index.ts +61 -61
package/tests/converters.test.mjs +126 -126
package/tests/diff.test.mjs +240 -240
package/tests/loader-validator.test.mjs +19 -19
package/tests/normalizer.test.mjs +115 -115
package/tsconfig.json +15 -15
package/dist/converters/index.d.ts +0 -13
package/dist/converters/index.js +0 -89
package/dist/diff/index.d.ts +0 -21
package/dist/diff/index.js +0 -195
package/dist/index.d.ts +0 -6
package/dist/index.js +0 -6
package/dist/loader/index.d.ts +0 -13
package/dist/loader/index.js +0 -19
package/dist/normalizer/index.d.ts +0 -11
package/dist/normalizer/index.js +0 -116
package/dist/types/index.d.ts +0 -57
package/dist/types/index.js +0 -1
package/dist/validator/index.d.ts +0 -7
package/dist/validator/index.js +0 -47

package/tests/converters.test.mjs CHANGED Viewed

@@ -1,126 +1,126 @@
-import test from "node:test";
-import assert from "node:assert/strict";
-import * as core from "../dist/index.js";
-const { toOpenAPI, toGraphQLSDL, toWebSocketModel } = core;
-test("toOpenAPI produces basic OpenAPI structure from UniSpec document", () => {
-  const doc = {
-    unispecVersion: "0.1.0",
-    service: {
-      name: "test-service",
-      title: "Service",
-      description: "Desc",
-      protocols: {
-        rest: {
-          servers: [{ url: "https://api.example.com" }],
-          paths: {
-            "/ping": {
-              get: {},
-            },
-          },
-          components: {
-            schemas: {
-              PingResponse: {
-                type: "object",
-              },
-            },
-          },
-          security: [{ bearerAuth: [] }],
-          tags: [
-            {
-              name: "ping",
-              description: "Ping operations",
-            },
-          ],
-          "x-extra-rest-field": true,
-        },
-      },
-    },
-  };
-  const openapi = toOpenAPI(doc);
-  assert.equal(openapi.openapi, "3.1.0");
-  assert.equal(openapi.info.title, "Service");
-  assert.equal(openapi.info.description, "Desc");
-  assert.ok(openapi.paths["/ping"]);
-  assert.ok(openapi.components);
-  assert.ok(openapi.components.schemas.PingResponse);
-  assert.ok(Array.isArray(openapi.security));
-  assert.ok(Array.isArray(openapi.tags));
-  assert.equal(openapi["x-extra-rest-field"], true);
-});
-test("toGraphQLSDL returns SDL string wrapper", () => {
-  const doc = {
-    unispecVersion: "0.1.0",
-    service: {
-      name: "test-service",
-      title: "GraphQL Service",
-      description: "GraphQL description",
-      protocols: {
-        graphql: {
-          schema: {
-            sdl: "type Query { hello: String! }",
-          },
-        },
-      },
-    },
-  };
-  const result = toGraphQLSDL(doc);
-  assert.equal(typeof result, "object");
-  assert.equal(typeof result.sdl, "string");
-  assert.equal(result.sdl, "type Query { hello: String! }");
-});
-test("toWebSocketModel returns WS model wrapper", () => {
-  const doc = {
-    unispecVersion: "0.1.0",
-    service: {
-      name: "test-service",
-      title: "WS Service",
-      description: "WebSocket description",
-      protocols: {
-        websocket: {
-          channels: {
-            ping: {
-              summary: "Ping channel",
-              description: "Ping messages",
-              direction: "bidirectional",
-              messages: [
-                {
-                  name: "ping",
-                  summary: "Ping message",
-                },
-              ],
-            },
-          },
-        },
-      },
-    },
-  };
-  const model = toWebSocketModel(doc);
-  assert.equal(typeof model, "object");
-  assert.ok(model["x-unispec-ws"]);
-  assert.deepEqual(model.service, {
-    name: "test-service",
-    title: "WS Service",
-    description: "WebSocket description",
-  });
-  assert.ok(Array.isArray(model.channels));
-  assert.equal(model.channels.length, 1);
-  assert.equal(model.channels[0].name, "ping");
-  assert.equal(model.channels[0].summary, "Ping channel");
-  assert.equal(model.channels[0].description, "Ping messages");
-  assert.equal(model.channels[0].direction, "bidirectional");
-  assert.ok(Array.isArray(model.channels[0].messages));
-  assert.equal(model.channels[0].messages[0].name, "ping");
-  assert.equal(model.channels[0].messages[0].summary, "Ping message");
-  assert.ok(model.rawProtocol);
-});
+import test from "node:test";
+import assert from "node:assert/strict";
+import * as core from "../dist/index.js";
+const { toOpenAPI, toGraphQLSDL, toWebSocketModel } = core;
+test("toOpenAPI produces basic OpenAPI structure from UniSpec document", () => {
+  const doc = {
+    unispecVersion: "0.1.0",
+    service: {
+      name: "test-service",
+      title: "Service",
+      description: "Desc",
+      protocols: {
+        rest: {
+          servers: [{ url: "https://api.example.com" }],
+          paths: {
+            "/ping": {
+              get: {},
+            },
+          },
+          components: {
+            schemas: {
+              PingResponse: {
+                type: "object",
+              },
+            },
+          },
+          security: [{ bearerAuth: [] }],
+          tags: [
+            {
+              name: "ping",
+              description: "Ping operations",
+            },
+          ],
+          "x-extra-rest-field": true,
+        },
+      },
+    },
+  };
+  const openapi = toOpenAPI(doc);
+  assert.equal(openapi.openapi, "3.1.0");
+  assert.equal(openapi.info.title, "Service");
+  assert.equal(openapi.info.description, "Desc");
+  assert.ok(openapi.paths["/ping"]);
+  assert.ok(openapi.components);
+  assert.ok(openapi.components.schemas.PingResponse);
+  assert.ok(Array.isArray(openapi.security));
+  assert.ok(Array.isArray(openapi.tags));
+  assert.equal(openapi["x-extra-rest-field"], true);
+});
+test("toGraphQLSDL returns SDL string wrapper", () => {
+  const doc = {
+    unispecVersion: "0.1.0",
+    service: {
+      name: "test-service",
+      title: "GraphQL Service",
+      description: "GraphQL description",
+      protocols: {
+        graphql: {
+          schema: {
+            sdl: "type Query { hello: String! }",
+          },
+        },
+      },
+    },
+  };
+  const result = toGraphQLSDL(doc);
+  assert.equal(typeof result, "object");
+  assert.equal(typeof result.sdl, "string");
+  assert.equal(result.sdl, "type Query { hello: String! }");
+});
+test("toWebSocketModel returns WS model wrapper", () => {
+  const doc = {
+    unispecVersion: "0.1.0",
+    service: {
+      name: "test-service",
+      title: "WS Service",
+      description: "WebSocket description",
+      protocols: {
+        websocket: {
+          channels: {
+            ping: {
+              summary: "Ping channel",
+              description: "Ping messages",
+              direction: "bidirectional",
+              messages: [
+                {
+                  name: "ping",
+                  summary: "Ping message",
+                },
+              ],
+            },
+          },
+        },
+      },
+    },
+  };
+  const model = toWebSocketModel(doc);
+  assert.equal(typeof model, "object");
+  assert.ok(model["x-unispec-ws"]);
+  assert.deepEqual(model.service, {
+    name: "test-service",
+    title: "WS Service",
+    description: "WebSocket description",
+  });
+  assert.ok(Array.isArray(model.channels));
+  assert.equal(model.channels.length, 1);
+  assert.equal(model.channels[0].name, "ping");
+  assert.equal(model.channels[0].summary, "Ping channel");
+  assert.equal(model.channels[0].description, "Ping messages");
+  assert.equal(model.channels[0].direction, "bidirectional");
+  assert.ok(Array.isArray(model.channels[0].messages));
+  assert.equal(model.channels[0].messages[0].name, "ping");
+  assert.equal(model.channels[0].messages[0].summary, "Ping message");
+  assert.ok(model.rawProtocol);
+});