@ndla/types-backend 1.0.34 → 1.0.35

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

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

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

package/build/article-api.d.ts

@@ -1,156 +1,57 @@
-export declare enum ArticleSortEnum {
-    ByRelevanceDesc = "-relevance",
-    ByRelevanceAsc = "relevance",
-    ByTitleDesc = "-title",
-    ByTitleAsc = "title",
-    ByLastUpdatedDesc = "-lastUpdated",
-    ByLastUpdatedAsc = "lastUpdated",
-    ByIdDesc = "-id",
-    ByIdAsc = "id"
-}
-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 interface IArticleContentV2DTO {
-    content: string;
-    language: string;
-}
-export interface IArticleDumpDTO {
-    totalCount: number;
-    page: number;
-    pageSize: number;
-    language: string;
-    results: IArticleV2DTO[];
-}
-export interface IArticleIdsDTO {
-    articleId: number;
-    externalIds: string[];
-}
-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;
-    fallback?: boolean;
-    scrollId?: string;
-    grepCodes?: string[];
-}
-export interface IArticleSummaryV2DTO {
-    id: number;
-    title: IArticleTitleDTO;
-    visualElement?: IVisualElementDTO;
-    introduction?: IArticleIntroductionDTO;
-    metaDescription?: IArticleMetaDescriptionDTO;
-    metaImage?: IArticleMetaImageDTO;
-    url: string;
-    license: string;
-    articleType: string;
-    lastUpdated: string;
-    supportedLanguages: string[];
-    grepCodes: string[];
-    availability: string;
-}
-export interface IArticleTagDTO {
-    tags: string[];
-    language: string;
-}
-export interface IArticleTitleDTO {
-    title: string;
-    htmlTitle: string;
-    language: string;
-}
-export interface IArticleV2DTO {
-    id: number;
-    oldNdlaUrl?: string;
-    revision: number;
-    title: IArticleTitleDTO;
-    content: IArticleContentV2DTO;
-    copyright: ICopyrightDTO;
-    tags: IArticleTagDTO;
-    requiredLibraries: IRequiredLibraryDTO[];
-    visualElement?: IVisualElementDTO;
-    metaImage?: IArticleMetaImageDTO;
-    introduction?: IArticleIntroductionDTO;
-    metaDescription: IArticleMetaDescriptionDTO;
-    created: string;
-    updated: string;
-    updatedBy: string;
-    published: string;
-    articleType: string;
-    supportedLanguages: string[];
-    grepCodes: string[];
-    conceptIds: number[];
-    availability: string;
-    relatedContent: (IRelatedContentLinkDTO | number)[];
-    revisionDate?: string;
-    slug?: string;
-    disclaimer?: IDisclaimerDTO;
-}
-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 IDisclaimerDTO {
-    disclaimer: string;
-    language: string;
-}
-export interface ILicenseDTO {
-    license: string;
-    description?: string;
-    url?: string;
-}
-export interface IRelatedContentLinkDTO {
-    title: string;
-    url: string;
-}
-export interface IRequiredLibraryDTO {
-    mediaType: string;
-    name: string;
-    url: string;
-}
-export interface ISearchResultV2DTO {
-    totalCount: number;
-    page?: number;
-    pageSize: number;
-    language: string;
-    results: IArticleSummaryV2DTO[];
-}
-export interface ITagsSearchResultDTO {
-    totalCount: number;
-    page: number;
-    pageSize: number;
-    language: string;
-    results: string[];
-}
-export interface IVisualElementDTO {
-    visualElement: string;
-    language: string;
-}
-export type Sort = ArticleSortEnum;
+import * as openapi from "./article-api-openapi";
+type schemas = openapi.components["schemas"];
+export { openapi };
+export type AllErrors = schemas["AllErrors"];
+export type IAllErrors = schemas["AllErrors"];
+export type ArticleContentV2DTO = schemas["ArticleContentV2DTO"];
+export type IArticleContentV2DTO = schemas["ArticleContentV2DTO"];
+export type ArticleIdV2DTO = schemas["ArticleIdV2DTO"];
+export type IArticleIdV2DTO = schemas["ArticleIdV2DTO"];
+export type ArticleIdsDTO = schemas["ArticleIdsDTO"];
+export type IArticleIdsDTO = schemas["ArticleIdsDTO"];
+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 ArticleSummaryV2DTO = schemas["ArticleSummaryV2DTO"];
+export type IArticleSummaryV2DTO = schemas["ArticleSummaryV2DTO"];
+export type ArticleTagDTO = schemas["ArticleTagDTO"];
+export type IArticleTagDTO = schemas["ArticleTagDTO"];
+export type ArticleTitleDTO = schemas["ArticleTitleDTO"];
+export type IArticleTitleDTO = schemas["ArticleTitleDTO"];
+export type ArticleV2DTO = schemas["ArticleV2DTO"];
+export type IArticleV2DTO = schemas["ArticleV2DTO"];
+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 DisclaimerDTO = schemas["DisclaimerDTO"];
+export type IDisclaimerDTO = schemas["DisclaimerDTO"];
+export type ErrorBody = schemas["ErrorBody"];
+export type IErrorBody = schemas["ErrorBody"];
+export type LicenseDTO = schemas["LicenseDTO"];
+export type ILicenseDTO = schemas["LicenseDTO"];
+export type NotFoundWithSupportedLanguages = schemas["NotFoundWithSupportedLanguages"];
+export type INotFoundWithSupportedLanguages = schemas["NotFoundWithSupportedLanguages"];
+export type RelatedContentLinkDTO = schemas["RelatedContentLinkDTO"];
+export type IRelatedContentLinkDTO = schemas["RelatedContentLinkDTO"];
+export type RequiredLibraryDTO = schemas["RequiredLibraryDTO"];
+export type IRequiredLibraryDTO = schemas["RequiredLibraryDTO"];
+export type SearchResultV2DTO = schemas["SearchResultV2DTO"];
+export type ISearchResultV2DTO = schemas["SearchResultV2DTO"];
+export type Sort = schemas["Sort"];
+export type ISort = schemas["Sort"];
+export type TagsSearchResultDTO = schemas["TagsSearchResultDTO"];
+export type ITagsSearchResultDTO = schemas["TagsSearchResultDTO"];
+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"];

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

package/build/article-api.js.map

@@ -1 +1 @@
-{"version":3,"file":"article-api.js","sourceRoot":"","sources":["../article-api.ts"],"names":[],"mappings":";AAAA,2CAA2C;;;AAE3C,IAAY,eASX;AATD,WAAY,eAAe;IACzB,iDAA8B,CAAA;IAC9B,+CAA4B,CAAA;IAC5B,yCAAsB,CAAA;IACtB,uCAAoB,CAAA;IACpB,qDAAkC,CAAA;IAClC,mDAAgC,CAAA;IAChC,mCAAgB,CAAA;IAChB,iCAAc,CAAA;AAChB,CAAC,EATW,eAAe,+BAAf,eAAe,QAS1B"}
+{"version":3,"file":"article-api.js","sourceRoot":"","sources":["../article-api.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oEAAoE;AACpE,6DAAiD;AAGxC,0BAAO"}