@ndla/types-backend 1.0.34 → 1.0.35

package/build/myndla-api-openapi.js

@@ -0,0 +1,7 @@
+"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

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

package/build/myndla-api.d.ts

@@ -1,125 +1,69 @@
-export interface IBreadcrumbDTO {
-    id: string;
-    name: string;
-}
-export interface IConfigMetaDTO {
-    key: string;
-    value: (boolean | string[]);
-    updatedAt: string;
-    updatedBy: string;
-}
-export interface IConfigMetaRestrictedDTO {
-    key: string;
-    value: (boolean | string[]);
-}
-export interface IFolderDTO {
-    id: string;
-    name: string;
-    status: string;
-    parentId?: string;
-    breadcrumbs: IBreadcrumbDTO[];
-    subfolders: IFolderDataDTO[];
-    resources: IResourceDTO[];
-    rank: number;
-    created: string;
-    updated: string;
-    shared?: string;
-    description?: string;
-    owner?: IOwnerDTO;
-}
-export type IFolderDataDTO = IFolderDTO;
-export interface IMyNDLAGroupDTO {
-    id: string;
-    displayName: string;
-    isPrimarySchool: boolean;
-    parentId?: string;
-}
-export interface IMyNDLAUserDTO {
-    id: number;
-    feideId: string;
-    username: string;
-    email: string;
-    displayName: string;
-    favoriteSubjects: string[];
-    role: UserRole;
-    organization: string;
-    groups: IMyNDLAGroupDTO[];
-    arenaEnabled: boolean;
-    arenaAccepted: boolean;
-    shareNameAccepted: boolean;
-}
-export interface INewFolderDTO {
-    name: string;
-    parentId?: string;
-    status?: string;
-    description?: string;
-}
-export interface INewResourceDTO {
-    resourceType: ResourceType;
-    path: string;
-    tags?: string[];
-    resourceId: string;
-}
-export interface IOwnerDTO {
-    name: string;
-}
-export interface IResourceDTO {
-    id: string;
-    resourceType: ResourceType;
-    path: string;
-    created: string;
-    tags: string[];
-    resourceId: string;
-    rank?: number;
-}
-export interface IResourceStatsDTO {
-    type: string;
-    number: number;
-}
-export interface ISingleResourceStatsDTO {
-    id: string;
-    favourites: number;
-}
-export interface IStatsDTO {
-    numberOfUsers: number;
-    numberOfFolders: number;
-    numberOfResources: number;
-    numberOfTags: number;
-    numberOfSubjects: number;
-    numberOfSharedFolders: number;
-    numberOfMyNdlaLearningPaths: number;
-    favouritedResources: IResourceStatsDTO[];
-    favourited: {
-        [key: string]: number;
-    };
-    users: IUserStatsDTO;
-}
-export interface IUpdatedFolderDTO {
-    name?: string;
-    status?: string;
-    description?: string;
-}
-export interface IUpdatedMyNDLAUserDTO {
-    favoriteSubjects?: string[];
-    arenaEnabled?: boolean;
-    arenaAccepted?: boolean;
-    shareNameAccepted?: boolean;
-}
-export interface IUpdatedResourceDTO {
-    tags?: string[];
-    resourceId?: string;
-}
-export interface IUserFolderDTO {
-    folders: IFolderDTO[];
-    sharedFolders: IFolderDTO[];
-}
-export interface IUserStatsDTO {
-    total: number;
-    employees: number;
-    students: number;
-    withFavourites: number;
-    noFavourites: number;
-    arena: number;
-}
-export type ResourceType = ("article" | "audio" | "concept" | "image" | "learningpath" | "multidisciplinary" | "topic" | "video");
-export type UserRole = ("employee" | "student");
+import * as openapi from "./myndla-api-openapi";
+type schemas = openapi.components["schemas"];
+export { openapi };
+export type AllErrors = schemas["AllErrors"];
+export type IAllErrors = schemas["AllErrors"];
+export type BreadcrumbDTO = schemas["BreadcrumbDTO"];
+export type IBreadcrumbDTO = schemas["BreadcrumbDTO"];
+export type ConfigKey = schemas["ConfigKey"];
+export type IConfigKey = schemas["ConfigKey"];
+export type ConfigMetaDTO = schemas["ConfigMetaDTO"];
+export type IConfigMetaDTO = schemas["ConfigMetaDTO"];
+export type ConfigMetaRestrictedDTO = schemas["ConfigMetaRestrictedDTO"];
+export type IConfigMetaRestrictedDTO = schemas["ConfigMetaRestrictedDTO"];
+export type ConfigMetaValueDTO = schemas["ConfigMetaValueDTO"];
+export type IConfigMetaValueDTO = schemas["ConfigMetaValueDTO"];
+export type ErrorBody = schemas["ErrorBody"];
+export type IErrorBody = schemas["ErrorBody"];
+export type ExportedUserDataDTO = schemas["ExportedUserDataDTO"];
+export type IExportedUserDataDTO = schemas["ExportedUserDataDTO"];
+export type FolderDTO = schemas["FolderDTO"];
+export type IFolderDTO = schemas["FolderDTO"];
+export type FolderDataDTO = schemas["FolderDataDTO"];
+export type IFolderDataDTO = schemas["FolderDataDTO"];
+export type FolderSortRequestDTO = schemas["FolderSortRequestDTO"];
+export type IFolderSortRequestDTO = schemas["FolderSortRequestDTO"];
+export type FolderStatus = schemas["FolderStatus"];
+export type IFolderStatus = schemas["FolderStatus"];
+export type Map_Long = schemas["Map_Long"];
+export type IMap_Long = schemas["Map_Long"];
+export type Map_Map_String_Long = schemas["Map_Map_String_Long"];
+export type IMap_Map_String_Long = schemas["Map_Map_String_Long"];
+export type MyNDLAGroupDTO = schemas["MyNDLAGroupDTO"];
+export type IMyNDLAGroupDTO = schemas["MyNDLAGroupDTO"];
+export type MyNDLAUserDTO = schemas["MyNDLAUserDTO"];
+export type IMyNDLAUserDTO = schemas["MyNDLAUserDTO"];
+export type NewFolderDTO = schemas["NewFolderDTO"];
+export type INewFolderDTO = schemas["NewFolderDTO"];
+export type NewResourceDTO = schemas["NewResourceDTO"];
+export type INewResourceDTO = schemas["NewResourceDTO"];
+export type NotFoundWithSupportedLanguages = schemas["NotFoundWithSupportedLanguages"];
+export type INotFoundWithSupportedLanguages = schemas["NotFoundWithSupportedLanguages"];
+export type OwnerDTO = schemas["OwnerDTO"];
+export type IOwnerDTO = schemas["OwnerDTO"];
+export type ResourceDTO = schemas["ResourceDTO"];
+export type IResourceDTO = schemas["ResourceDTO"];
+export type ResourceStatsDTO = schemas["ResourceStatsDTO"];
+export type IResourceStatsDTO = schemas["ResourceStatsDTO"];
+export type ResourceType = schemas["ResourceType"];
+export type IResourceType = schemas["ResourceType"];
+export type SingleResourceStatsDTO = schemas["SingleResourceStatsDTO"];
+export type ISingleResourceStatsDTO = schemas["SingleResourceStatsDTO"];
+export type StatsDTO = schemas["StatsDTO"];
+export type IStatsDTO = schemas["StatsDTO"];
+export type UpdatedFolderDTO = schemas["UpdatedFolderDTO"];
+export type IUpdatedFolderDTO = schemas["UpdatedFolderDTO"];
+export type UpdatedMyNDLAUserDTO = schemas["UpdatedMyNDLAUserDTO"];
+export type IUpdatedMyNDLAUserDTO = schemas["UpdatedMyNDLAUserDTO"];
+export type UpdatedResourceDTO = schemas["UpdatedResourceDTO"];
+export type IUpdatedResourceDTO = schemas["UpdatedResourceDTO"];
+export type UserFolderDTO = schemas["UserFolderDTO"];
+export type IUserFolderDTO = schemas["UserFolderDTO"];
+export type UserRole = schemas["UserRole"];
+export type IUserRole = schemas["UserRole"];
+export type UserStatsDTO = schemas["UserStatsDTO"];
+export type IUserStatsDTO = schemas["UserStatsDTO"];
+export type ValidationErrorBody = schemas["ValidationErrorBody"];
+export type IValidationErrorBody = schemas["ValidationErrorBody"];
+export type ValidationMessage = schemas["ValidationMessage"];
+export type IValidationMessage = schemas["ValidationMessage"];

package/build/myndla-api.js

@@ -1,4 +1,30 @@
 "use strict";
-// DO NOT EDIT: generated file by scala-tsi
+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;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.openapi = void 0;
+// This file was generated by OpenApiPlugin, do not edit it manually
+var openapi = __importStar(require("./myndla-api-openapi"));
+exports.openapi = openapi;
 //# sourceMappingURL=myndla-api.js.map

package/build/myndla-api.js.map

@@ -1 +1 @@
-{"version":3,"file":"myndla-api.js","sourceRoot":"","sources":["../myndla-api.ts"],"names":[],"mappings":";AAAA,2CAA2C"}
+{"version":3,"file":"myndla-api.js","sourceRoot":"","sources":["../myndla-api.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oEAAoE;AACpE,4DAAgD;AAGvC,0BAAO"}

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

@@ -0,0 +1,249 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export type paths = {
+    "/oembed-proxy/v1/oembed": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Returns oEmbed information for a given url.
+         * @description Returns oEmbed information for a given url.
+         */
+        get: operations["getOembed-proxyV1Oembed"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+};
+export type webhooks = Record<string, never>;
+export type components = {
+    schemas: {
+        /** AllErrors */
+        AllErrors: components["schemas"]["ErrorBody"] | components["schemas"]["NotFoundWithSupportedLanguages"] | components["schemas"]["ValidationErrorBody"];
+        /**
+         * ErrorBody
+         * @description Information about an error
+         */
+        ErrorBody: {
+            /** @description Code stating the type of error */
+            code: string;
+            /** @description Description of the error */
+            description: string;
+            /** @description When the error occurred */
+            occurredAt: string;
+            /**
+             * Format: int32
+             * @description Numeric http status code
+             */
+            statusCode: number;
+        };
+        /**
+         * NotFoundWithSupportedLanguages
+         * @description Information about an error
+         */
+        NotFoundWithSupportedLanguages: {
+            /** @description Code stating the type of error */
+            code: string;
+            /** @description Description of the error */
+            description: string;
+            /** @description When the error occurred */
+            occurredAt: string;
+            /** @description List of supported languages */
+            supportedLanguages?: string[];
+            /**
+             * Format: int32
+             * @description Numeric http status code
+             */
+            statusCode: number;
+        };
+        /**
+         * OEmbedDTO
+         * @description oEmbed information for an url.
+         */
+        OEmbedDTO: {
+            /** @description The resource type */
+            type: string;
+            /** @description The oEmbed version number. This must be 1.0. */
+            version: string;
+            /** @description A text title, describing the resource. */
+            title?: string;
+            /** @description A text description, describing the resource. Not standard. */
+            description?: string;
+            /** @description The name of the author/owner of the resource. */
+            authorName?: string;
+            /** @description A URL for the author/owner of the resource. */
+            authorUrl?: string;
+            /** @description The name of the resource provider. */
+            providerName?: string;
+            /** @description The url of the resource provider. */
+            providerUrl?: string;
+            /**
+             * Format: int64
+             * @description The suggested cache lifetime for this resource, in seconds. Consumers may choose to use this value or not.
+             */
+            cacheAge?: number;
+            /** @description A URL to a thumbnail image representing the resource. The thumbnail must respect any maxwidth and maxheight parameters. If this parameter is present, thumbnail_width and thumbnail_height must also be present. */
+            thumbnailUrl?: string;
+            /**
+             * Format: int64
+             * @description The width of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_height must also be present.
+             */
+            thumbnailWidth?: number;
+            /**
+             * Format: int64
+             * @description The height of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_width must also be present.
+             */
+            thumbnailHeight?: number;
+            /** @description The source URL of the image. Consumers should be able to insert this URL into an <img> element. Only HTTP and HTTPS URLs are valid. Required if type is photo. */
+            url?: string;
+            /**
+             * Format: int64
+             * @description The width in pixels. Required if type is photo/video/rich
+             */
+            width?: number;
+            /**
+             * Format: int64
+             * @description The height in pixels. Required if type is photo/video/rich
+             */
+            height?: number;
+            /** @description The HTML required to embed a video player. The HTML should have no padding or margins. Consumers may wish to load the HTML in an off-domain iframe to avoid XSS vulnerabilities. Required if type is video/rich. */
+            html?: string;
+        };
+        /**
+         * ValidationErrorBody
+         * @description Information about an error
+         */
+        ValidationErrorBody: {
+            /** @description Code stating the type of error */
+            code: string;
+            /** @description Description of the error */
+            description: string;
+            /** @description When the error occurred */
+            occurredAt: string;
+            /** @description List of validation messages */
+            messages?: components["schemas"]["ValidationMessage"][];
+            /**
+             * Format: int32
+             * @description Numeric http status code
+             */
+            statusCode: number;
+        };
+        /**
+         * ValidationMessage
+         * @description A message describing a validation error on a specific field
+         */
+        ValidationMessage: {
+            /** @description The field the error occured in */
+            field: string;
+            /** @description The validation message */
+            message: string;
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+};
+export type $defs = Record<string, never>;
+export interface operations {
+    "getOembed-proxyV1Oembed": {
+        parameters: {
+            query: {
+                /** @description The URL to retrieve embedding information for */
+                url: string;
+                /** @description The maximum width of the embedded resource */
+                maxwidth?: string;
+                /** @description The maximum height of the embedded resource */
+                maxheight?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OEmbedDTO"];
+                };
+            };
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+            410: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorBody"];
+                };
+            };
+            502: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AllErrors"];
+                };
+            };
+        };
+    };
+}

package/build/oembed-proxy-openapi.js

@@ -0,0 +1,7 @@
+"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

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

package/build/oembed-proxy.d.ts

@@ -0,0 +1,15 @@
+import * as openapi from "./oembed-proxy-openapi";
+type schemas = openapi.components["schemas"];
+export { openapi };
+export type AllErrors = schemas["AllErrors"];
+export type IAllErrors = schemas["AllErrors"];
+export type ErrorBody = schemas["ErrorBody"];
+export type IErrorBody = schemas["ErrorBody"];
+export type NotFoundWithSupportedLanguages = schemas["NotFoundWithSupportedLanguages"];
+export type INotFoundWithSupportedLanguages = schemas["NotFoundWithSupportedLanguages"];
+export type OEmbedDTO = schemas["OEmbedDTO"];
+export type IOEmbedDTO = schemas["OEmbedDTO"];
+export type ValidationErrorBody = schemas["ValidationErrorBody"];
+export type IValidationErrorBody = schemas["ValidationErrorBody"];
+export type ValidationMessage = schemas["ValidationMessage"];
+export type IValidationMessage = schemas["ValidationMessage"];

package/build/oembed-proxy.js

@@ -0,0 +1,30 @@
+"use strict";
+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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.openapi = void 0;
+// This file was generated by OpenApiPlugin, do not edit it manually
+var openapi = __importStar(require("./oembed-proxy-openapi"));
+exports.openapi = openapi;
+//# sourceMappingURL=oembed-proxy.js.map

package/build/oembed-proxy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"oembed-proxy.js","sourceRoot":"","sources":["../oembed-proxy.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oEAAoE;AACpE,8DAAkD;AAGzC,0BAAO"}