@ndla/types-backend 1.0.34 → 1.0.35

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

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

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

package/build/audio-api.d.ts

@@ -1,190 +1,69 @@
-export declare enum AudioSortEnum {
-    ByRelevanceDesc = "-relevance",
-    ByRelevanceAsc = "relevance",
-    ByTitleDesc = "-title",
-    ByTitleAsc = "title",
-    ByLastUpdatedDesc = "-lastUpdated",
-    ByLastUpdatedAsc = "lastUpdated",
-    ByIdDesc = "-id",
-    ByIdAsc = "id"
-}
-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 IAudioDTO {
-    url: string;
-    mimeType: string;
-    fileSize: number;
-    language: string;
-}
-export interface IAudioMetaInformationDTO {
-    id: number;
-    revision: number;
-    title: ITitleDTO;
-    audioFile: IAudioDTO;
-    copyright: ICopyrightDTO;
-    tags: ITagDTO;
-    supportedLanguages: string[];
-    audioType: string;
-    podcastMeta?: IPodcastMetaDTO;
-    series?: ISeriesDTO;
-    manuscript?: IManuscriptDTO;
-    created: string;
-    updated: string;
-}
-export interface IAudioSummaryDTO {
-    id: number;
-    title: ITitleDTO;
-    audioType: string;
-    url: string;
-    license: string;
-    supportedLanguages: string[];
-    manuscript?: IManuscriptDTO;
-    podcastMeta?: IPodcastMetaDTO;
-    series?: ISeriesSummaryDTO;
-    lastUpdated: string;
-}
-export interface IAudioSummarySearchResultDTO {
-    totalCount: number;
-    page?: number;
-    pageSize: number;
-    language: string;
-    results: IAudioSummaryDTO[];
-}
-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 ICoverPhotoDTO {
-    id: string;
-    url: string;
-    altText: string;
-}
-export interface IDescriptionDTO {
-    description: string;
-    language: string;
-}
-export interface ILicenseDTO {
-    license: string;
-    description?: string;
-    url?: string;
-}
-export interface IManuscriptDTO {
-    manuscript: string;
-    language: string;
-}
-export interface INewAudioMetaInformationDTO {
-    title: string;
-    language: string;
-    copyright: ICopyrightDTO;
-    tags: string[];
-    audioType?: string;
-    podcastMeta?: INewPodcastMetaDTO;
-    seriesId?: number;
-    manuscript?: string;
-}
-export interface INewPodcastMetaDTO {
-    introduction: string;
-    coverPhotoId: string;
-    coverPhotoAltText: string;
-}
-export interface INewSeriesDTO {
-    title: string;
-    description: string;
-    coverPhotoId: string;
-    coverPhotoAltText: string;
-    episodes: number[];
-    language: string;
-    revision?: number;
-    hasRSS?: boolean;
-}
-export interface IPodcastMetaDTO {
-    introduction: string;
-    coverPhoto: ICoverPhotoDTO;
-    language: string;
-}
-export interface ISearchParamsDTO {
-    query?: string;
-    license?: string;
-    language?: string;
-    page?: number;
-    pageSize?: number;
-    sort?: Sort;
-    scrollId?: string;
-    audioType?: string;
-    filterBySeries?: boolean;
-    fallback?: boolean;
-}
-export interface ISeriesDTO {
-    id: number;
-    revision: number;
-    title: ITitleDTO;
-    description: IDescriptionDTO;
-    coverPhoto: ICoverPhotoDTO;
-    episodes?: IAudioMetaInformationDTO[];
-    supportedLanguages: string[];
-    hasRSS: boolean;
-}
-export interface ISeriesSearchParamsDTO {
-    query?: string;
-    language?: string;
-    page?: number;
-    pageSize?: number;
-    sort?: Sort;
-    scrollId?: string;
-    fallback?: boolean;
-}
-export interface ISeriesSummaryDTO {
-    id: number;
-    title: ITitleDTO;
-    description: IDescriptionDTO;
-    supportedLanguages: string[];
-    episodes?: IAudioSummaryDTO[];
-    coverPhoto: ICoverPhotoDTO;
-}
-export interface ISeriesSummarySearchResultDTO {
-    totalCount: number;
-    page?: number;
-    pageSize: number;
-    language: string;
-    results: ISeriesSummaryDTO[];
-}
-export interface ITagDTO {
-    tags: string[];
-    language: string;
-}
-export interface ITagsSearchResultDTO {
-    totalCount: number;
-    page: number;
-    pageSize: number;
-    language: string;
-    results: string[];
-}
-export interface ITitleDTO {
-    title: string;
-    language: string;
-}
-export interface ITranscriptionResultDTO {
-    status: string;
-    transcription?: string;
-}
-export interface IUpdatedAudioMetaInformationDTO {
-    revision: number;
-    title: string;
-    language: string;
-    copyright: ICopyrightDTO;
-    tags: string[];
-    audioType?: string;
-    podcastMeta?: INewPodcastMetaDTO;
-    seriesId?: number;
-    manuscript?: string;
-}
-export type Sort = AudioSortEnum;
+import * as openapi from "./audio-api-openapi";
+type schemas = openapi.components["schemas"];
+export { openapi };
+export type AllErrors = schemas["AllErrors"];
+export type IAllErrors = schemas["AllErrors"];
+export type AudioDTO = schemas["AudioDTO"];
+export type IAudioDTO = schemas["AudioDTO"];
+export type AudioMetaInformationDTO = schemas["AudioMetaInformationDTO"];
+export type IAudioMetaInformationDTO = schemas["AudioMetaInformationDTO"];
+export type AudioSummaryDTO = schemas["AudioSummaryDTO"];
+export type IAudioSummaryDTO = schemas["AudioSummaryDTO"];
+export type AudioSummarySearchResultDTO = schemas["AudioSummarySearchResultDTO"];
+export type IAudioSummarySearchResultDTO = schemas["AudioSummarySearchResultDTO"];
+export type AuthorDTO = schemas["AuthorDTO"];
+export type IAuthorDTO = schemas["AuthorDTO"];
+export type ContributorType = schemas["ContributorType"];
+export type IContributorType = schemas["ContributorType"];
+export type CopyrightDTO = schemas["CopyrightDTO"];
+export type ICopyrightDTO = schemas["CopyrightDTO"];
+export type CoverPhotoDTO = schemas["CoverPhotoDTO"];
+export type ICoverPhotoDTO = schemas["CoverPhotoDTO"];
+export type DescriptionDTO = schemas["DescriptionDTO"];
+export type IDescriptionDTO = schemas["DescriptionDTO"];
+export type ErrorBody = schemas["ErrorBody"];
+export type IErrorBody = schemas["ErrorBody"];
+export type LicenseDTO = schemas["LicenseDTO"];
+export type ILicenseDTO = schemas["LicenseDTO"];
+export type ManuscriptDTO = schemas["ManuscriptDTO"];
+export type IManuscriptDTO = schemas["ManuscriptDTO"];
+export type MetaDataAndFileForm = schemas["MetaDataAndFileForm"];
+export type IMetaDataAndFileForm = schemas["MetaDataAndFileForm"];
+export type MetaDataAndOptFileForm = schemas["MetaDataAndOptFileForm"];
+export type IMetaDataAndOptFileForm = schemas["MetaDataAndOptFileForm"];
+export type NewAudioMetaInformationDTO = schemas["NewAudioMetaInformationDTO"];
+export type INewAudioMetaInformationDTO = schemas["NewAudioMetaInformationDTO"];
+export type NewPodcastMetaDTO = schemas["NewPodcastMetaDTO"];
+export type INewPodcastMetaDTO = schemas["NewPodcastMetaDTO"];
+export type NewSeriesDTO = schemas["NewSeriesDTO"];
+export type INewSeriesDTO = schemas["NewSeriesDTO"];
+export type NotFoundWithSupportedLanguages = schemas["NotFoundWithSupportedLanguages"];
+export type INotFoundWithSupportedLanguages = schemas["NotFoundWithSupportedLanguages"];
+export type PodcastMetaDTO = schemas["PodcastMetaDTO"];
+export type IPodcastMetaDTO = schemas["PodcastMetaDTO"];
+export type SearchParamsDTO = schemas["SearchParamsDTO"];
+export type ISearchParamsDTO = schemas["SearchParamsDTO"];
+export type SeriesDTO = schemas["SeriesDTO"];
+export type ISeriesDTO = schemas["SeriesDTO"];
+export type SeriesSearchParamsDTO = schemas["SeriesSearchParamsDTO"];
+export type ISeriesSearchParamsDTO = schemas["SeriesSearchParamsDTO"];
+export type SeriesSummaryDTO = schemas["SeriesSummaryDTO"];
+export type ISeriesSummaryDTO = schemas["SeriesSummaryDTO"];
+export type SeriesSummarySearchResultDTO = schemas["SeriesSummarySearchResultDTO"];
+export type ISeriesSummarySearchResultDTO = schemas["SeriesSummarySearchResultDTO"];
+export type Sort = schemas["Sort"];
+export type ISort = schemas["Sort"];
+export type TagDTO = schemas["TagDTO"];
+export type ITagDTO = schemas["TagDTO"];
+export type TagsSearchResultDTO = schemas["TagsSearchResultDTO"];
+export type ITagsSearchResultDTO = schemas["TagsSearchResultDTO"];
+export type TitleDTO = schemas["TitleDTO"];
+export type ITitleDTO = schemas["TitleDTO"];
+export type TranscriptionResultDTO = schemas["TranscriptionResultDTO"];
+export type ITranscriptionResultDTO = schemas["TranscriptionResultDTO"];
+export type UpdatedAudioMetaInformationDTO = schemas["UpdatedAudioMetaInformationDTO"];
+export type IUpdatedAudioMetaInformationDTO = schemas["UpdatedAudioMetaInformationDTO"];
+export type ValidationErrorBody = schemas["ValidationErrorBody"];
+export type IValidationErrorBody = schemas["ValidationErrorBody"];
+export type ValidationMessage = schemas["ValidationMessage"];
+export type IValidationMessage = schemas["ValidationMessage"];

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

package/build/audio-api.js.map

@@ -1 +1 @@
-{"version":3,"file":"audio-api.js","sourceRoot":"","sources":["../audio-api.ts"],"names":[],"mappings":";AAAA,2CAA2C;;;AAE3C,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":"audio-api.js","sourceRoot":"","sources":["../audio-api.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oEAAoE;AACpE,2DAA+C;AAGtC,0BAAO"}