@ndla/types-backend 1.0.34 → 1.0.35

package/build/image-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=image-api-openapi.js.map

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

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

package/build/image-api.d.ts

@@ -1,174 +1,61 @@
-export type ContributorType = ("artist" | "cowriter" | "compiler" | "composer" | "correction" | "director" | "distributor" | "editorial" | "facilitator" | "idea" | "illustrator" | "linguistic" | "originator" | "photographer" | "processor" | "publisher" | "reader" | "rightsholder" | "scriptwriter" | "supplier" | "translator" | "writer");
-export interface IAuthorDTO {
-    type: ContributorType;
-    name: string;
-}
-export interface ICopyrightDTO {
-    license: ILicenseDTO;
-    origin?: string;
-    creators: IAuthorDTO[];
-    processors: IAuthorDTO[];
-    rightsholders: IAuthorDTO[];
-    validFrom?: string;
-    validTo?: string;
-    processed: boolean;
-}
-export interface IEditorNoteDTO {
-    timestamp: string;
-    updatedBy: string;
-    note: string;
-}
-export interface IImageAltTextDTO {
-    alttext: string;
-    language: string;
-}
-export interface IImageCaptionDTO {
-    caption: string;
-    language: string;
-}
-export interface IImageDTO {
-    url: string;
-    size: number;
-    contentType: string;
-}
-export interface IImageDimensionsDTO {
-    width: number;
-    height: number;
-}
-export interface IImageFileDTO {
-    fileName: string;
-    size: number;
-    contentType: string;
-    imageUrl: string;
-    dimensions?: IImageDimensionsDTO;
-    language: string;
-}
-export interface IImageMetaInformationV2DTO {
-    id: string;
-    metaUrl: string;
-    title: IImageTitleDTO;
-    alttext: IImageAltTextDTO;
-    imageUrl: string;
-    size: number;
-    contentType: string;
-    copyright: ICopyrightDTO;
-    tags: IImageTagDTO;
-    caption: IImageCaptionDTO;
-    supportedLanguages: string[];
-    created: string;
-    createdBy: string;
-    modelRelease: string;
-    editorNotes?: IEditorNoteDTO[];
-    imageDimensions?: IImageDimensionsDTO;
-}
-export interface IImageMetaInformationV3DTO {
-    id: string;
-    metaUrl: string;
-    title: IImageTitleDTO;
-    alttext: IImageAltTextDTO;
-    copyright: ICopyrightDTO;
-    tags: IImageTagDTO;
-    caption: IImageCaptionDTO;
-    supportedLanguages: string[];
-    created: string;
-    createdBy: string;
-    modelRelease: string;
-    editorNotes?: IEditorNoteDTO[];
-    image: IImageFileDTO;
-}
-export interface IImageMetaSummaryDTO {
-    id: string;
-    title: IImageTitleDTO;
-    contributors: string[];
-    altText: IImageAltTextDTO;
-    caption: IImageCaptionDTO;
-    previewUrl: string;
-    metaUrl: string;
-    license: string;
-    supportedLanguages: string[];
-    modelRelease?: string;
-    editorNotes?: string[];
-    lastUpdated: string;
-    fileSize: number;
-    contentType: string;
-    imageDimensions?: IImageDimensionsDTO;
-}
-export interface IImageTagDTO {
-    tags: string[];
-    language: string;
-}
-export interface IImageTitleDTO {
-    title: string;
-    language: string;
-}
-export interface ILicenseDTO {
-    license: string;
-    description?: string;
-    url?: string;
-}
-export interface INewImageMetaInformationV2DTO {
-    title: string;
-    alttext?: string;
-    copyright: ICopyrightDTO;
-    tags: string[];
-    caption: string;
-    language: string;
-    modelReleased?: string;
-}
-export interface ISearchParamsDTO {
-    query?: string;
-    license?: string;
-    language?: string;
-    fallback?: boolean;
-    minimumSize?: number;
-    includeCopyrighted?: boolean;
-    sort?: Sort;
-    page?: number;
-    pageSize?: number;
-    podcastFriendly?: boolean;
-    scrollId?: string;
-    modelReleased?: string[];
-    users?: string[];
-}
-export interface ISearchResultDTO {
-    totalCount: number;
-    page?: number;
-    pageSize: number;
-    language: string;
-    results: IImageMetaSummaryDTO[];
-}
-export interface ISearchResultV3DTO {
-    totalCount: number;
-    page?: number;
-    pageSize: number;
-    language: string;
-    results: IImageMetaInformationV3DTO[];
-}
-export interface ITagsSearchResultDTO {
-    totalCount: number;
-    page: number;
-    pageSize: number;
-    language: string;
-    results: string[];
-}
-export interface IUpdateImageMetaInformationDTO {
-    language: string;
-    title?: string;
-    alttext: UpdateOrDeleteString;
-    copyright?: ICopyrightDTO;
-    tags?: string[];
-    caption?: string;
-    modelReleased?: string;
-}
-export declare enum ImageSortEnum {
-    ByRelevanceDesc = "-relevance",
-    ByRelevanceAsc = "relevance",
-    ByTitleDesc = "-title",
-    ByTitleAsc = "title",
-    ByLastUpdatedDesc = "-lastUpdated",
-    ByLastUpdatedAsc = "lastUpdated",
-    ByIdDesc = "-id",
-    ByIdAsc = "id"
-}
-export type Sort = ImageSortEnum;
-export type UpdateOrDeleteString = (null | undefined | string);
+import * as openapi from "./image-api-openapi";
+type schemas = openapi.components["schemas"];
+export { openapi };
+export type AllErrors = schemas["AllErrors"];
+export type IAllErrors = schemas["AllErrors"];
+export type AuthorDTO = schemas["AuthorDTO"];
+export type IAuthorDTO = schemas["AuthorDTO"];
+export type ContributorType = schemas["ContributorType"];
+export type IContributorType = schemas["ContributorType"];
+export type CopyMetaDataAndFileForm = schemas["CopyMetaDataAndFileForm"];
+export type ICopyMetaDataAndFileForm = schemas["CopyMetaDataAndFileForm"];
+export type CopyrightDTO = schemas["CopyrightDTO"];
+export type ICopyrightDTO = schemas["CopyrightDTO"];
+export type EditorNoteDTO = schemas["EditorNoteDTO"];
+export type IEditorNoteDTO = schemas["EditorNoteDTO"];
+export type ErrorBody = schemas["ErrorBody"];
+export type IErrorBody = schemas["ErrorBody"];
+export type ImageAltTextDTO = schemas["ImageAltTextDTO"];
+export type IImageAltTextDTO = schemas["ImageAltTextDTO"];
+export type ImageCaptionDTO = schemas["ImageCaptionDTO"];
+export type IImageCaptionDTO = schemas["ImageCaptionDTO"];
+export type ImageDimensionsDTO = schemas["ImageDimensionsDTO"];
+export type IImageDimensionsDTO = schemas["ImageDimensionsDTO"];
+export type ImageFileDTO = schemas["ImageFileDTO"];
+export type IImageFileDTO = schemas["ImageFileDTO"];
+export type ImageMetaInformationV2DTO = schemas["ImageMetaInformationV2DTO"];
+export type IImageMetaInformationV2DTO = schemas["ImageMetaInformationV2DTO"];
+export type ImageMetaInformationV3DTO = schemas["ImageMetaInformationV3DTO"];
+export type IImageMetaInformationV3DTO = schemas["ImageMetaInformationV3DTO"];
+export type ImageMetaSummaryDTO = schemas["ImageMetaSummaryDTO"];
+export type IImageMetaSummaryDTO = schemas["ImageMetaSummaryDTO"];
+export type ImageTagDTO = schemas["ImageTagDTO"];
+export type IImageTagDTO = schemas["ImageTagDTO"];
+export type ImageTitleDTO = schemas["ImageTitleDTO"];
+export type IImageTitleDTO = schemas["ImageTitleDTO"];
+export type LicenseDTO = schemas["LicenseDTO"];
+export type ILicenseDTO = schemas["LicenseDTO"];
+export type MetaDataAndFileForm = schemas["MetaDataAndFileForm"];
+export type IMetaDataAndFileForm = schemas["MetaDataAndFileForm"];
+export type NewImageMetaInformationV2DTO = schemas["NewImageMetaInformationV2DTO"];
+export type INewImageMetaInformationV2DTO = schemas["NewImageMetaInformationV2DTO"];
+export type NotFoundWithSupportedLanguages = schemas["NotFoundWithSupportedLanguages"];
+export type INotFoundWithSupportedLanguages = schemas["NotFoundWithSupportedLanguages"];
+export type SearchParamsDTO = schemas["SearchParamsDTO"];
+export type ISearchParamsDTO = schemas["SearchParamsDTO"];
+export type SearchResultDTO = schemas["SearchResultDTO"];
+export type ISearchResultDTO = schemas["SearchResultDTO"];
+export type SearchResultV3DTO = schemas["SearchResultV3DTO"];
+export type ISearchResultV3DTO = schemas["SearchResultV3DTO"];
+export type Sort = schemas["Sort"];
+export type ISort = schemas["Sort"];
+export type TagsSearchResultDTO = schemas["TagsSearchResultDTO"];
+export type ITagsSearchResultDTO = schemas["TagsSearchResultDTO"];
+export type UpdateImageMetaInformationDTO = schemas["UpdateImageMetaInformationDTO"];
+export type IUpdateImageMetaInformationDTO = schemas["UpdateImageMetaInformationDTO"];
+export type UpdateMetaDataAndFileForm = schemas["UpdateMetaDataAndFileForm"];
+export type IUpdateMetaDataAndFileForm = schemas["UpdateMetaDataAndFileForm"];
+export type ValidationErrorBody = schemas["ValidationErrorBody"];
+export type IValidationErrorBody = schemas["ValidationErrorBody"];
+export type ValidationMessage = schemas["ValidationMessage"];
+export type IValidationMessage = schemas["ValidationMessage"];

package/build/image-api.js

@@ -1,16 +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.ImageSortEnum = void 0;
-var ImageSortEnum;
-(function (ImageSortEnum) {
-    ImageSortEnum["ByRelevanceDesc"] = "-relevance";
-    ImageSortEnum["ByRelevanceAsc"] = "relevance";
-    ImageSortEnum["ByTitleDesc"] = "-title";
-    ImageSortEnum["ByTitleAsc"] = "title";
-    ImageSortEnum["ByLastUpdatedDesc"] = "-lastUpdated";
-    ImageSortEnum["ByLastUpdatedAsc"] = "lastUpdated";
-    ImageSortEnum["ByIdDesc"] = "-id";
-    ImageSortEnum["ByIdAsc"] = "id";
-})(ImageSortEnum || (exports.ImageSortEnum = ImageSortEnum = {}));
+exports.openapi = void 0;
+// This file was generated by OpenApiPlugin, do not edit it manually
+var openapi = __importStar(require("./image-api-openapi"));
+exports.openapi = openapi;
 //# sourceMappingURL=image-api.js.map

package/build/image-api.js.map

@@ -1 +1 @@
-{"version":3,"file":"image-api.js","sourceRoot":"","sources":["../image-api.ts"],"names":[],"mappings":";AAAA,2CAA2C;;;AAyL3C,IAAY,aASX;AATD,WAAY,aAAa;IACvB,+CAA8B,CAAA;IAC9B,6CAA4B,CAAA;IAC5B,uCAAsB,CAAA;IACtB,qCAAoB,CAAA;IACpB,mDAAkC,CAAA;IAClC,iDAAgC,CAAA;IAChC,iCAAgB,CAAA;IAChB,+BAAc,CAAA;AAChB,CAAC,EATW,aAAa,6BAAb,aAAa,QASxB"}
+{"version":3,"file":"image-api.js","sourceRoot":"","sources":["../image-api.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oEAAoE;AACpE,2DAA+C;AAGtC,0BAAO"}