@ndla/types-backend 1.0.34 → 1.0.35

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

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

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

package/build/draft-api.d.ts

@@ -1,292 +1,117 @@
-export type Availability = ("everyone" | "teacher");
-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 declare enum DraftSortEnum {
-    ByRelevanceDesc = "-relevance",
-    ByRelevanceAsc = "relevance",
-    ByTitleDesc = "-title",
-    ByTitleAsc = "title",
-    ByLastUpdatedDesc = "-lastUpdated",
-    ByLastUpdatedAsc = "lastUpdated",
-    ByIdDesc = "-id",
-    ByIdAsc = "id"
-}
-export type Grade = (1 | 2 | 3 | 4 | 5);
-export interface IArticleContentDTO {
-    content: string;
-    language: string;
-}
-export interface IArticleDTO {
-    id: number;
-    oldNdlaUrl?: string;
-    revision: number;
-    status: IStatusDTO;
-    title?: IArticleTitleDTO;
-    content?: IArticleContentDTO;
-    copyright?: IDraftCopyrightDTO;
-    tags?: IArticleTagDTO;
-    requiredLibraries: IRequiredLibraryDTO[];
-    visualElement?: IVisualElementDTO;
-    introduction?: IArticleIntroductionDTO;
-    metaDescription?: IArticleMetaDescriptionDTO;
-    metaImage?: IArticleMetaImageDTO;
-    created: string;
-    updated: string;
-    updatedBy: string;
-    published: string;
-    articleType: string;
-    supportedLanguages: string[];
-    notes: IEditorNoteDTO[];
-    editorLabels: string[];
-    grepCodes: string[];
-    conceptIds: number[];
-    availability: string;
-    relatedContent: (IRelatedContentLinkDTO | number)[];
-    revisions: IRevisionMetaDTO[];
-    responsible?: IDraftResponsibleDTO;
-    slug?: string;
-    comments: ICommentDTO[];
-    prioritized: boolean;
-    priority: string;
-    started: boolean;
-    qualityEvaluation?: IQualityEvaluationDTO;
-    disclaimer?: IDisclaimerDTO;
-}
-export interface IArticleIntroductionDTO {
-    introduction: string;
-    htmlIntroduction: string;
-    language: string;
-}
-export interface IArticleMetaDescriptionDTO {
-    metaDescription: string;
-    language: string;
-}
-export interface IArticleMetaImageDTO {
-    url: string;
-    alt: string;
-    language: string;
-}
-export interface IArticleSearchParamsDTO {
-    query?: string;
-    language?: string;
-    license?: string;
-    page?: number;
-    pageSize?: number;
-    ids?: number[];
-    articleTypes?: string[];
-    sort?: Sort;
-    scrollId?: string;
-    fallback?: boolean;
-    grepCodes?: string[];
-}
-export interface IArticleSummaryDTO {
-    id: number;
-    title: IArticleTitleDTO;
-    visualElement?: IVisualElementDTO;
-    introduction?: IArticleIntroductionDTO;
-    url: string;
-    license: string;
-    articleType: string;
-    supportedLanguages: string[];
-    tags?: IArticleTagDTO;
-    notes: string[];
-    users: string[];
-    grepCodes: string[];
-    status: IStatusDTO;
-    updated: string;
-}
-export interface IArticleTagDTO {
-    tags: string[];
-    language: string;
-}
-export interface IArticleTitleDTO {
-    title: string;
-    htmlTitle: string;
-    language: string;
-}
-export interface IAuthorDTO {
-    type: ContributorType;
-    name: string;
-}
-export interface ICommentDTO {
-    id: string;
-    content: string;
-    created: string;
-    updated: string;
-    isOpen: boolean;
-    solved: boolean;
-}
-export interface IDisclaimerDTO {
-    disclaimer: string;
-    language: string;
-}
-export interface IDraftCopyrightDTO {
-    license?: ILicenseDTO;
-    origin?: string;
-    creators: IAuthorDTO[];
-    processors: IAuthorDTO[];
-    rightsholders: IAuthorDTO[];
-    validFrom?: string;
-    validTo?: string;
-    processed: boolean;
-}
-export interface IDraftResponsibleDTO {
-    responsibleId: string;
-    lastUpdated: string;
-}
-export interface IEditorNoteDTO {
-    note: string;
-    user: string;
-    status: IStatusDTO;
-    timestamp: string;
-}
-export interface IGrepCodesSearchResultDTO {
-    totalCount: number;
-    page: number;
-    pageSize: number;
-    results: string[];
-}
-export interface ILicenseDTO {
-    license: string;
-    description?: string;
-    url?: string;
-}
-export interface INewArticleDTO {
-    language: string;
-    title: string;
-    published?: string;
-    content?: string;
-    tags?: string[];
-    introduction?: string;
-    metaDescription?: string;
-    metaImage?: INewArticleMetaImageDTO;
-    visualElement?: string;
-    copyright?: IDraftCopyrightDTO;
-    requiredLibraries?: IRequiredLibraryDTO[];
-    articleType: string;
-    notes?: string[];
-    editorLabels?: string[];
-    grepCodes?: string[];
-    conceptIds?: number[];
-    availability?: string;
-    relatedContent?: (IRelatedContentLinkDTO | number)[];
-    revisionMeta?: IRevisionMetaDTO[];
-    responsibleId?: string;
-    slug?: string;
-    comments?: INewCommentDTO[];
-    prioritized?: boolean;
-    priority?: string;
-    qualityEvaluation?: IQualityEvaluationDTO;
-    disclaimer?: string;
-}
-export interface INewArticleMetaImageDTO {
-    id: string;
-    alt: string;
-}
-export interface INewCommentDTO {
-    content: string;
-    isOpen?: boolean;
-}
-export interface IQualityEvaluationDTO {
-    grade: Grade;
-    note?: string;
-}
-export interface IRelatedContentLinkDTO {
-    title: string;
-    url: string;
-}
-export interface IRequiredLibraryDTO {
-    mediaType: string;
-    name: string;
-    url: string;
-}
-export interface IRevisionMetaDTO {
-    id?: string;
-    revisionDate: string;
-    note: string;
-    status: string;
-}
-export interface ISavedSearchDTO {
-    searchUrl: string;
-    searchPhrase: string;
-}
-export interface ISearchResultDTO {
-    totalCount: number;
-    page: number;
-    pageSize: number;
-    language: string;
-    results: IArticleSummaryDTO[];
-}
-export interface IStatusDTO {
-    current: string;
-    other: string[];
-}
-export interface ITagsSearchResultDTO {
-    totalCount: number;
-    page: number;
-    pageSize: number;
-    language: string;
-    results: string[];
-}
-export interface IUpdatedArticleDTO {
-    revision: number;
-    language?: string;
-    title?: string;
-    status?: string;
-    published?: string;
-    content?: string;
-    tags?: string[];
-    introduction?: string;
-    metaDescription?: string;
-    metaImage: UpdateOrDeleteNewArticleMetaImageDTO;
-    visualElement?: string;
-    copyright?: IDraftCopyrightDTO;
-    requiredLibraries?: IRequiredLibraryDTO[];
-    articleType?: string;
-    notes?: string[];
-    editorLabels?: string[];
-    grepCodes?: string[];
-    conceptIds?: number[];
-    createNewVersion?: boolean;
-    availability?: string;
-    relatedContent?: (IRelatedContentLinkDTO | number)[];
-    revisionMeta?: IRevisionMetaDTO[];
-    responsibleId: UpdateOrDeleteString;
-    slug?: string;
-    comments?: IUpdatedCommentDTO[];
-    prioritized?: boolean;
-    priority?: string;
-    qualityEvaluation?: IQualityEvaluationDTO;
-    disclaimer?: string;
-}
-export interface IUpdatedCommentDTO {
-    id?: string;
-    content: string;
-    isOpen?: boolean;
-    solved?: boolean;
-}
-export interface IUpdatedUserDataDTO {
-    savedSearches?: ISavedSearchDTO[];
-    latestEditedArticles?: string[];
-    latestEditedConcepts?: string[];
-    favoriteSubjects?: string[];
-}
-export interface IUploadedFileDTO {
-    filename: string;
-    mime: string;
-    extension: string;
-    path: string;
-}
-export interface IUserDataDTO {
-    userId: string;
-    savedSearches?: ISavedSearchDTO[];
-    latestEditedArticles?: string[];
-    latestEditedConcepts?: string[];
-    favoriteSubjects?: string[];
-}
-export interface IVisualElementDTO {
-    visualElement: string;
-    language: string;
-}
-export type Sort = DraftSortEnum;
-export type UpdateOrDeleteNewArticleMetaImageDTO = (null | undefined | INewArticleMetaImageDTO);
-export type UpdateOrDeleteString = (null | undefined | string);
+import * as openapi from "./draft-api-openapi";
+type schemas = openapi.components["schemas"];
+export { openapi };
+export type AllErrors = schemas["AllErrors"];
+export type IAllErrors = schemas["AllErrors"];
+export type ArticleContentDTO = schemas["ArticleContentDTO"];
+export type IArticleContentDTO = schemas["ArticleContentDTO"];
+export type ArticleDTO = schemas["ArticleDTO"];
+export type IArticleDTO = schemas["ArticleDTO"];
+export type ArticleIntroductionDTO = schemas["ArticleIntroductionDTO"];
+export type IArticleIntroductionDTO = schemas["ArticleIntroductionDTO"];
+export type ArticleMetaDescriptionDTO = schemas["ArticleMetaDescriptionDTO"];
+export type IArticleMetaDescriptionDTO = schemas["ArticleMetaDescriptionDTO"];
+export type ArticleMetaImageDTO = schemas["ArticleMetaImageDTO"];
+export type IArticleMetaImageDTO = schemas["ArticleMetaImageDTO"];
+export type ArticleSearchParamsDTO = schemas["ArticleSearchParamsDTO"];
+export type IArticleSearchParamsDTO = schemas["ArticleSearchParamsDTO"];
+export type ArticleSearchResultDTO = schemas["ArticleSearchResultDTO"];
+export type IArticleSearchResultDTO = schemas["ArticleSearchResultDTO"];
+export type ArticleSummaryDTO = schemas["ArticleSummaryDTO"];
+export type IArticleSummaryDTO = schemas["ArticleSummaryDTO"];
+export type ArticleTagDTO = schemas["ArticleTagDTO"];
+export type IArticleTagDTO = schemas["ArticleTagDTO"];
+export type ArticleTitleDTO = schemas["ArticleTitleDTO"];
+export type IArticleTitleDTO = schemas["ArticleTitleDTO"];
+export type AuthorDTO = schemas["AuthorDTO"];
+export type IAuthorDTO = schemas["AuthorDTO"];
+export type CommentDTO = schemas["CommentDTO"];
+export type ICommentDTO = schemas["CommentDTO"];
+export type ContentIdDTO = schemas["ContentIdDTO"];
+export type IContentIdDTO = schemas["ContentIdDTO"];
+export type ContributorType = schemas["ContributorType"];
+export type IContributorType = schemas["ContributorType"];
+export type DisclaimerDTO = schemas["DisclaimerDTO"];
+export type IDisclaimerDTO = schemas["DisclaimerDTO"];
+export type DraftCopyrightDTO = schemas["DraftCopyrightDTO"];
+export type IDraftCopyrightDTO = schemas["DraftCopyrightDTO"];
+export type DraftResponsibleDTO = schemas["DraftResponsibleDTO"];
+export type IDraftResponsibleDTO = schemas["DraftResponsibleDTO"];
+export type EditorNoteDTO = schemas["EditorNoteDTO"];
+export type IEditorNoteDTO = schemas["EditorNoteDTO"];
+export type ErrorBody = schemas["ErrorBody"];
+export type IErrorBody = schemas["ErrorBody"];
+export type FileForm = schemas["FileForm"];
+export type IFileForm = schemas["FileForm"];
+export type Grade = schemas["Grade"];
+export type IGrade = schemas["Grade"];
+export type GrepCodesSearchResultDTO = schemas["GrepCodesSearchResultDTO"];
+export type IGrepCodesSearchResultDTO = schemas["GrepCodesSearchResultDTO"];
+export type LicenseDTO = schemas["LicenseDTO"];
+export type ILicenseDTO = schemas["LicenseDTO"];
+export type Map_List_String = schemas["Map_List_String"];
+export type IMap_List_String = schemas["Map_List_String"];
+export type MultiPartialPublishResultDTO = schemas["MultiPartialPublishResultDTO"];
+export type IMultiPartialPublishResultDTO = schemas["MultiPartialPublishResultDTO"];
+export type NewArticleDTO = schemas["NewArticleDTO"];
+export type INewArticleDTO = schemas["NewArticleDTO"];
+export type NewArticleMetaImageDTO = schemas["NewArticleMetaImageDTO"];
+export type INewArticleMetaImageDTO = schemas["NewArticleMetaImageDTO"];
+export type NewCommentDTO = schemas["NewCommentDTO"];
+export type INewCommentDTO = schemas["NewCommentDTO"];
+export type NotFoundWithSupportedLanguages = schemas["NotFoundWithSupportedLanguages"];
+export type INotFoundWithSupportedLanguages = schemas["NotFoundWithSupportedLanguages"];
+export type PartialArticleFieldsDTO = schemas["PartialArticleFieldsDTO"];
+export type IPartialArticleFieldsDTO = schemas["PartialArticleFieldsDTO"];
+export type PartialBulkArticlesDTO = schemas["PartialBulkArticlesDTO"];
+export type IPartialBulkArticlesDTO = schemas["PartialBulkArticlesDTO"];
+export type PartialPublishFailureDTO = schemas["PartialPublishFailureDTO"];
+export type IPartialPublishFailureDTO = schemas["PartialPublishFailureDTO"];
+export type QualityEvaluationDTO = schemas["QualityEvaluationDTO"];
+export type IQualityEvaluationDTO = schemas["QualityEvaluationDTO"];
+export type RelatedContentLinkDTO = schemas["RelatedContentLinkDTO"];
+export type IRelatedContentLinkDTO = schemas["RelatedContentLinkDTO"];
+export type RequiredLibraryDTO = schemas["RequiredLibraryDTO"];
+export type IRequiredLibraryDTO = schemas["RequiredLibraryDTO"];
+export type RevisionMetaDTO = schemas["RevisionMetaDTO"];
+export type IRevisionMetaDTO = schemas["RevisionMetaDTO"];
+export type SavedSearchDTO = schemas["SavedSearchDTO"];
+export type ISavedSearchDTO = schemas["SavedSearchDTO"];
+export type Sort = schemas["Sort"];
+export type ISort = schemas["Sort"];
+export type StatusDTO = schemas["StatusDTO"];
+export type IStatusDTO = schemas["StatusDTO"];
+export type TagsSearchResultDTO = schemas["TagsSearchResultDTO"];
+export type ITagsSearchResultDTO = schemas["TagsSearchResultDTO"];
+export type UpdatedArticleDTO = schemas["UpdatedArticleDTO"];
+export type IUpdatedArticleDTO = schemas["UpdatedArticleDTO"];
+export type UpdatedCommentDTO = schemas["UpdatedCommentDTO"];
+export type IUpdatedCommentDTO = schemas["UpdatedCommentDTO"];
+export type UpdatedUserDataDTO = schemas["UpdatedUserDataDTO"];
+export type IUpdatedUserDataDTO = schemas["UpdatedUserDataDTO"];
+export type UploadedFileDTO = schemas["UploadedFileDTO"];
+export type IUploadedFileDTO = schemas["UploadedFileDTO"];
+export type UserDataDTO = schemas["UserDataDTO"];
+export type IUserDataDTO = schemas["UserDataDTO"];
+export type ValidationErrorBody = schemas["ValidationErrorBody"];
+export type IValidationErrorBody = schemas["ValidationErrorBody"];
+export type ValidationMessage = schemas["ValidationMessage"];
+export type IValidationMessage = schemas["ValidationMessage"];
+export type VisualElementDTO = schemas["VisualElementDTO"];
+export type IVisualElementDTO = schemas["VisualElementDTO"];
+export type availability = schemas["availability"];
+export type Iavailability = schemas["availability"];
+export type grepCodes = schemas["grepCodes"];
+export type IgrepCodes = schemas["grepCodes"];
+export type license = schemas["license"];
+export type Ilicense = schemas["license"];
+export type metaDescription = schemas["metaDescription"];
+export type ImetaDescription = schemas["metaDescription"];
+export type published = schemas["published"];
+export type Ipublished = schemas["published"];
+export type relatedContent = schemas["relatedContent"];
+export type IrelatedContent = schemas["relatedContent"];
+export type revisionDate = schemas["revisionDate"];
+export type IrevisionDate = schemas["revisionDate"];
+export type tags = schemas["tags"];
+export type Itags = schemas["tags"];

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

package/build/draft-api.js.map

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