@ndla/types-backend 1.0.37 → 1.0.39

package/build/article-api-openapi.d.ts

@@ -1,7 +1,3 @@
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 export type paths = {
     "/article-api/v2/articles/tag-search": {
         parameters: {

package/build/article-api-openapi.js

@@ -1,7 +1,3 @@
 "use strict";
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=article-api-openapi.js.map

package/build/article-api-openapi.js.map

@@ -1 +1 @@
-{"version":3,"file":"article-api-openapi.js","sourceRoot":"","sources":["../article-api-openapi.ts"],"names":[],"mappings":";AAAA;;;GAGG"}
+{"version":3,"file":"article-api-openapi.js","sourceRoot":"","sources":["../article-api-openapi.ts"],"names":[],"mappings":""}

package/build/audio-api-openapi.d.ts

@@ -1,7 +1,3 @@
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 export type paths = {
     "/audio-api/v1/audio": {
         parameters: {
@@ -520,13 +516,13 @@ export type components = {
         MetaDataAndFileForm: {
             metadata: components["schemas"]["NewAudioMetaInformationDTO"];
             /** Format: binary */
-            file: string;
+            file: Blob;
         };
         /** MetaDataAndOptFileForm */
         MetaDataAndOptFileForm: {
             metadata: components["schemas"]["UpdatedAudioMetaInformationDTO"];
             /** Format: binary */
-            file?: string;
+            file?: Blob;
         };
         /**
          * NewAudioMetaInformationDTO

package/build/audio-api-openapi.js

@@ -1,7 +1,3 @@
 "use strict";
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=audio-api-openapi.js.map

package/build/audio-api-openapi.js.map

@@ -1 +1 @@
-{"version":3,"file":"audio-api-openapi.js","sourceRoot":"","sources":["../audio-api-openapi.ts"],"names":[],"mappings":";AAAA;;;GAGG"}
+{"version":3,"file":"audio-api-openapi.js","sourceRoot":"","sources":["../audio-api-openapi.ts"],"names":[],"mappings":""}

package/build/concept-api-openapi.d.ts

@@ -1,7 +1,3 @@
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 export type paths = {
     "/concept-api/v1/drafts/status-state-machine": {
         parameters: {

package/build/concept-api-openapi.js

@@ -1,7 +1,3 @@
 "use strict";
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=concept-api-openapi.js.map

package/build/concept-api-openapi.js.map

@@ -1 +1 @@
-{"version":3,"file":"concept-api-openapi.js","sourceRoot":"","sources":["../concept-api-openapi.ts"],"names":[],"mappings":";AAAA;;;GAGG"}
+{"version":3,"file":"concept-api-openapi.js","sourceRoot":"","sources":["../concept-api-openapi.ts"],"names":[],"mappings":""}

package/build/draft-api-openapi.d.ts

@@ -1,7 +1,3 @@
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 export type paths = {
     "/draft-api/v1/drafts/licenses": {
         parameters: {
@@ -789,7 +785,7 @@ export type components = {
         /** FileForm */
         FileForm: {
             /** Format: binary */
-            file: string;
+            file: Blob;
         };
         /**
          * Grade
@@ -1080,6 +1076,7 @@ export type components = {
             introduction?: string;
             /** @description A meta description */
             metaDescription?: string;
+            /** @description An image-api ID for the article meta image */
             metaImage?: components["schemas"]["NewArticleMetaImageDTO"] | null;
             /** @description A visual element for the article. May be anything from an image to a video or H5P */
             visualElement?: string;

package/build/draft-api-openapi.js

@@ -1,7 +1,3 @@
 "use strict";
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=draft-api-openapi.js.map

package/build/draft-api-openapi.js.map

@@ -1 +1 @@
-{"version":3,"file":"draft-api-openapi.js","sourceRoot":"","sources":["../draft-api-openapi.ts"],"names":[],"mappings":";AAAA;;;GAGG"}
+{"version":3,"file":"draft-api-openapi.js","sourceRoot":"","sources":["../draft-api-openapi.ts"],"names":[],"mappings":""}

package/build/frontpage-api-openapi.d.ts

@@ -1,7 +1,3 @@
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 export type paths = {
     "/frontpage-api/v1/subjectpage": {
         parameters: {

package/build/frontpage-api-openapi.js

@@ -1,7 +1,3 @@
 "use strict";
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=frontpage-api-openapi.js.map

package/build/frontpage-api-openapi.js.map

@@ -1 +1 @@
-{"version":3,"file":"frontpage-api-openapi.js","sourceRoot":"","sources":["../frontpage-api-openapi.ts"],"names":[],"mappings":";AAAA;;;GAGG"}
+{"version":3,"file":"frontpage-api-openapi.js","sourceRoot":"","sources":["../frontpage-api-openapi.ts"],"names":[],"mappings":""}

package/build/image-api-openapi.d.ts

@@ -1,7 +1,3 @@
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 export type paths = {
     "/image-api/v2/images": {
         parameters: {
@@ -380,7 +376,7 @@ export type components = {
         /** CopyMetaDataAndFileForm */
         CopyMetaDataAndFileForm: {
             /** Format: binary */
-            file: string;
+            file: Blob;
         };
         /**
          * CopyrightDTO
@@ -620,7 +616,7 @@ export type components = {
         MetaDataAndFileForm: {
             metadata: components["schemas"]["NewImageMetaInformationV2DTO"];
             /** Format: binary */
-            file: string;
+            file: Blob;
         };
         /**
          * NewImageMetaInformationV2DTO
@@ -807,7 +803,7 @@ export type components = {
         UpdateMetaDataAndFileForm: {
             metadata: components["schemas"]["UpdateImageMetaInformationDTO"];
             /** Format: binary */
-            file?: string;
+            file?: Blob;
         };
         /**
          * ValidationErrorBody
@@ -2088,7 +2084,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/octet-stream": string;
+                    "application/octet-stream": Blob;
                 };
             };
             400: {
@@ -2160,7 +2156,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/octet-stream": string;
+                    "application/octet-stream": Blob;
                 };
             };
             400: {

package/build/image-api-openapi.js

@@ -1,7 +1,3 @@
 "use strict";
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=image-api-openapi.js.map

package/build/image-api-openapi.js.map

@@ -1 +1 @@
-{"version":3,"file":"image-api-openapi.js","sourceRoot":"","sources":["../image-api-openapi.ts"],"names":[],"mappings":";AAAA;;;GAGG"}
+{"version":3,"file":"image-api-openapi.js","sourceRoot":"","sources":["../image-api-openapi.ts"],"names":[],"mappings":""}

package/build/learningpath-api-openapi.d.ts

@@ -1,7 +1,3 @@
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 export type paths = {
     "/learningpath-api/v2/learningpaths": {
         parameters: {

package/build/learningpath-api-openapi.js

@@ -1,7 +1,3 @@
 "use strict";
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=learningpath-api-openapi.js.map

package/build/learningpath-api-openapi.js.map

@@ -1 +1 @@
-{"version":3,"file":"learningpath-api-openapi.js","sourceRoot":"","sources":["../learningpath-api-openapi.ts"],"names":[],"mappings":";AAAA;;;GAGG"}
+{"version":3,"file":"learningpath-api-openapi.js","sourceRoot":"","sources":["../learningpath-api-openapi.ts"],"names":[],"mappings":""}

package/build/myndla-api-openapi.d.ts

@@ -1,7 +1,3 @@
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 export type paths = {
     "/myndla-api/v1/folders": {
         parameters: {

package/build/myndla-api-openapi.js

@@ -1,7 +1,3 @@
 "use strict";
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=myndla-api-openapi.js.map

package/build/myndla-api-openapi.js.map

@@ -1 +1 @@
-{"version":3,"file":"myndla-api-openapi.js","sourceRoot":"","sources":["../myndla-api-openapi.ts"],"names":[],"mappings":";AAAA;;;GAGG"}
+{"version":3,"file":"myndla-api-openapi.js","sourceRoot":"","sources":["../myndla-api-openapi.ts"],"names":[],"mappings":""}

package/build/oembed-proxy-openapi.d.ts

@@ -1,7 +1,3 @@
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 export type paths = {
     "/oembed-proxy/v1/oembed": {
         parameters: {

package/build/oembed-proxy-openapi.js

@@ -1,7 +1,3 @@
 "use strict";
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=oembed-proxy-openapi.js.map

package/build/oembed-proxy-openapi.js.map

@@ -1 +1 @@
-{"version":3,"file":"oembed-proxy-openapi.js","sourceRoot":"","sources":["../oembed-proxy-openapi.ts"],"names":[],"mappings":";AAAA;;;GAGG"}
+{"version":3,"file":"oembed-proxy-openapi.js","sourceRoot":"","sources":["../oembed-proxy-openapi.ts"],"names":[],"mappings":""}

package/build/scripts/generate-openapi.d.ts

@@ -0,0 +1 @@
+export {};

package/build/scripts/generate-openapi.js

@@ -0,0 +1,116 @@
+"use strict";
+/*
+ * Part of NDLA backend
+ * Copyright (C) 2025 NDLA
+ *
+ * See LICENSE
+ *
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var node_fs_1 = __importDefault(require("node:fs"));
+var openapi_typescript_1 = __importStar(require("openapi-typescript"));
+var typescript_1 = __importDefault(require("typescript"));
+if (process.argv.length !== 3) {
+    throw new Error("Invalid use");
+}
+var BLOB = typescript_1.default.factory.createTypeReferenceNode(typescript_1.default.factory.createIdentifier("Blob"));
+var NULL = typescript_1.default.factory.createLiteralTypeNode(typescript_1.default.factory.createNull()); // `null`
+function generate_types(appName) {
+    return __awaiter(this, void 0, void 0, function () {
+        var jsonFile, schema, ast, outputPath, output;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    jsonFile = "./openapi/".concat(appName, ".json");
+                    console.log("Parsing ".concat(jsonFile, " to generate typescript files..."));
+                    return [4 /*yield*/, node_fs_1.default.promises.readFile(jsonFile, "utf8")];
+                case 1:
+                    schema = _a.sent();
+                    return [4 /*yield*/, (0, openapi_typescript_1.default)(JSON.parse(schema), {
+                            exportType: true,
+                            transform: function (schemaObject, _options) {
+                                if (schemaObject.format === "binary") {
+                                    if (schemaObject.nullable) {
+                                        return typescript_1.default.factory.createUnionTypeNode([BLOB, NULL]);
+                                    }
+                                    else {
+                                        return BLOB;
+                                    }
+                                }
+                            },
+                        })];
+                case 2:
+                    ast = _a.sent();
+                    outputPath = "./".concat(appName, "-openapi.ts");
+                    output = (0, openapi_typescript_1.astToString)(ast);
+                    console.log("Outputting to ".concat(outputPath));
+                    node_fs_1.default.writeFileSync(outputPath, output);
+                    return [2 /*return*/];
+            }
+        });
+    });
+}
+generate_types(process.argv[2]);
+//# sourceMappingURL=generate-openapi.js.map

package/build/scripts/generate-openapi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-openapi.js","sourceRoot":"","sources":["../../scripts/generate-openapi.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,oDAAyB;AACzB,uEAA6E;AAC7E,0DAA0C;AAE1C,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;IAC9B,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC;AACjC,CAAC;AAED,IAAM,IAAI,GAAG,oBAAE,CAAC,OAAO,CAAC,uBAAuB,CAC7C,oBAAE,CAAC,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,CACpC,CAAC;AACF,IAAM,IAAI,GAAG,oBAAE,CAAC,OAAO,CAAC,qBAAqB,CAAC,oBAAE,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS;AAEjF,SAAe,cAAc,CAAC,OAAe;;;;;;oBACrC,QAAQ,GAAG,oBAAa,OAAO,UAAO,CAAC;oBAC7C,OAAO,CAAC,GAAG,CAAC,kBAAW,QAAQ,qCAAkC,CAAC,CAAC;oBACpD,qBAAM,iBAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAA;;oBAArD,MAAM,GAAG,SAA4C;oBAE/C,qBAAM,IAAA,4BAAS,EAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE;4BAC9C,UAAU,EAAE,IAAI;4BAChB,SAAS,YAAC,YAAY,EAAE,QAAQ;gCAC9B,IAAI,YAAY,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;oCACrC,IAAI,YAAY,CAAC,QAAQ,EAAE,CAAC;wCAC1B,OAAO,oBAAE,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;oCACtD,CAAC;yCAAM,CAAC;wCACN,OAAO,IAAI,CAAC;oCACd,CAAC;gCACH,CAAC;4BACH,CAAC;yBACF,CAAC,EAAA;;oBAXI,GAAG,GAAG,SAWV;oBAEI,UAAU,GAAG,YAAK,OAAO,gBAAa,CAAC;oBACvC,MAAM,GAAG,IAAA,gCAAW,EAAC,GAAG,CAAC,CAAC;oBAEhC,OAAO,CAAC,GAAG,CAAC,wBAAiB,UAAU,CAAE,CAAC,CAAC;oBAC3C,iBAAE,CAAC,aAAa,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;;;;;CACtC;AAED,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC"}

package/build/search-api-openapi.d.ts

@@ -1,7 +1,3 @@
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 export type paths = {
     "/search-api/v1/search/group": {
         parameters: {

package/build/search-api-openapi.js

@@ -1,7 +1,3 @@
 "use strict";
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=search-api-openapi.js.map

package/build/search-api-openapi.js.map

@@ -1 +1 @@
-{"version":3,"file":"search-api-openapi.js","sourceRoot":"","sources":["../search-api-openapi.ts"],"names":[],"mappings":";AAAA;;;GAGG"}
+{"version":3,"file":"search-api-openapi.js","sourceRoot":"","sources":["../search-api-openapi.ts"],"names":[],"mappings":""}

package/oembed-proxy/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "@ndla/types-backend/oembed-proxy",
+  "private": true,
+  "types": "../build/oembed-proxy.d.ts"
+}

package/package.json

@@ -1,32 +1,36 @@
 {
-    "name": "@ndla/types-backend",
-    "description": "Typescript type definitions for NDLA backend",
-    "license": "GPL-3.0",
-    "scripts": {
-        "build": "tsc",
-        "do-publish": "tsc"
-    },
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/NDLANO/backend.git",
-        "directory": "typescript/types-backend"
-    },
-    "author": "ndla@knowit.no",
-    "files": [
-        "build",
-        "article-api",
-        "audio-api",
-        "concept-api",
-        "draft-api",
-        "frontpage-api",
-        "image-api",
-        "learningpath-api",
-        "myndla-api",
-        "search-api"
-    ],
-    "devDependencies": {
-        "openapi-typescript": "^7.6.1",
-        "typescript": "^5.3.3"
-    },
-    "version": "1.0.37"
+  "name": "@ndla/types-backend",
+  "description": "Typescript type definitions for NDLA backend",
+  "license": "GPL-3.0",
+  "scripts": {
+    "build": "tsc",
+    "do-publish": "tsc",
+    "generate-typescript": "tsx scripts/generate-openapi.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/NDLANO/backend.git",
+    "directory": "typescript/types-backend"
+  },
+  "author": "ndla@knowit.no",
+  "files": [
+    "build",
+    "article-api",
+    "audio-api",
+    "concept-api",
+    "draft-api",
+    "frontpage-api",
+    "image-api",
+    "learningpath-api",
+    "myndla-api",
+    "oembed-proxy",
+    "search-api"
+  ],
+  "devDependencies": {
+    "@types/node": "^22.13.16",
+    "openapi-typescript": "^7.6.1",
+    "tsx": "^4.19.3",
+    "typescript": "^5.3.3"
+  },
+  "version": "1.0.39"
 }