@ndla/types-backend 0.1.1

package/build/article-api.d.ts

@@ -0,0 +1,157 @@
+export type Availability = ("everyone" | "teacher");
+export interface IArticleContentV2 {
+    content: string;
+    language: string;
+}
+export interface IArticleDump {
+    totalCount: number;
+    page: number;
+    pageSize: number;
+    language: string;
+    results: IArticleV2[];
+}
+export interface IArticleIds {
+    articleId: number;
+    externalIds: string[];
+}
+export interface IArticleIntroduction {
+    introduction: string;
+    language: string;
+}
+export interface IArticleMetaDescription {
+    metaDescription: string;
+    language: string;
+}
+export interface IArticleMetaImage {
+    url: string;
+    alt: string;
+    language: string;
+}
+export interface IArticleSearchParams {
+    query?: string;
+    language?: string;
+    license?: string;
+    page?: number;
+    pageSize?: number;
+    idList: number[];
+    articleTypes: string[];
+    sort?: string;
+    fallback?: boolean;
+    scrollId?: string;
+    grepCodes: string[];
+}
+export interface IArticleSummaryV2 {
+    id: number;
+    title: IArticleTitle;
+    visualElement?: IVisualElement;
+    introduction?: IArticleIntroduction;
+    metaDescription?: IArticleMetaDescription;
+    metaImage?: IArticleMetaImage;
+    url: string;
+    license: string;
+    articleType: string;
+    lastUpdated: string;
+    supportedLanguages: string[];
+    grepCodes: string[];
+    availability: string;
+}
+export interface IArticleTag {
+    tags: string[];
+    language: string;
+}
+export interface IArticleTitle {
+    title: string;
+    language: string;
+}
+export interface IArticleV2 {
+    id: number;
+    oldNdlaUrl?: string;
+    revision: number;
+    title: IArticleTitle;
+    content: IArticleContentV2;
+    copyright: ICopyright;
+    tags: IArticleTag;
+    requiredLibraries: IRequiredLibrary[];
+    visualElement?: IVisualElement;
+    metaImage?: IArticleMetaImage;
+    introduction?: IArticleIntroduction;
+    metaDescription: IArticleMetaDescription;
+    created: string;
+    updated: string;
+    updatedBy: string;
+    published: string;
+    articleType: string;
+    supportedLanguages: string[];
+    grepCodes: string[];
+    conceptIds: number[];
+    availability: string;
+    relatedContent: (IRelatedContentLink | number)[];
+    revisionDate?: string;
+    slug?: string;
+}
+export interface IAuthor {
+    type: string;
+    name: string;
+}
+export interface ICopyright {
+    license: ILicense;
+    origin: string;
+    creators: IAuthor[];
+    processors: IAuthor[];
+    rightsholders: IAuthor[];
+    agreementId?: number;
+    validFrom?: string;
+    validTo?: string;
+}
+export interface ILicense {
+    license: string;
+    description?: string;
+    url?: string;
+}
+export interface IPartialPublishArticle {
+    availability?: Availability;
+    grepCodes?: string[];
+    license?: string;
+    metaDescription?: IArticleMetaDescription[];
+    relatedContent?: (IRelatedContentLink | number)[];
+    tags?: IArticleTag[];
+    revisionDate?: (NullAlias | string);
+}
+export interface IRelatedContentLink {
+    title: string;
+    url: string;
+}
+export interface IRequiredLibrary {
+    mediaType: string;
+    name: string;
+    url: string;
+}
+export interface ISearchResultV2 {
+    totalCount: number;
+    page?: number;
+    pageSize: number;
+    language: string;
+    results: IArticleSummaryV2[];
+}
+export interface ITagsSearchResult {
+    totalCount: number;
+    page: number;
+    pageSize: number;
+    language: string;
+    results: string[];
+}
+export interface IValidationError {
+    code: string;
+    description: string;
+    messages: IValidationMessage[];
+    occuredAt: string;
+}
+export interface IValidationMessage {
+    field: string;
+    message: string;
+}
+export interface IVisualElement {
+    visualElement: string;
+    language: string;
+}
+export type NullAlias = null;

package/build/article-api.js

@@ -0,0 +1,4 @@
+"use strict";
+// DO NOT EDIT: generated file by scala-tsi
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=article-api.js.map

package/build/article-api.js.map

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

package/build/audio-api.d.ts

@@ -0,0 +1,184 @@
+export interface IAudio {
+    url: string;
+    mimeType: string;
+    fileSize: number;
+    language: string;
+}
+export interface IAudioMetaInformation {
+    id: number;
+    revision: number;
+    title: ITitle;
+    audioFile: IAudio;
+    copyright: ICopyright;
+    tags: ITag;
+    supportedLanguages: string[];
+    audioType: string;
+    podcastMeta?: IPodcastMeta;
+    series?: ISeries;
+    manuscript?: IManuscript;
+    created: string;
+    updated: string;
+}
+export interface IAudioSummary {
+    id: number;
+    title: ITitle;
+    audioType: string;
+    url: string;
+    license: string;
+    supportedLanguages: string[];
+    manuscript?: IManuscript;
+    podcastMeta?: IPodcastMeta;
+    series?: ISeriesSummary;
+    lastUpdated: string;
+}
+export interface IAudioSummarySearchResult {
+    totalCount: number;
+    page?: number;
+    pageSize: number;
+    language: string;
+    results: IAudioSummary[];
+}
+export interface IAuthor {
+    type: string;
+    name: string;
+}
+export interface ICopyright {
+    license: ILicense;
+    origin?: string;
+    creators: IAuthor[];
+    processors: IAuthor[];
+    rightsholders: IAuthor[];
+    agreementId?: number;
+    validFrom?: string;
+    validTo?: string;
+}
+export interface ICoverPhoto {
+    id: string;
+    url: string;
+    altText: string;
+}
+export interface IDescription {
+    description: string;
+    language: string;
+}
+export interface ILicense {
+    license: string;
+    description?: string;
+    url?: string;
+}
+export interface IManuscript {
+    manuscript: string;
+    language: string;
+}
+export interface INewAudioMetaInformation {
+    title: string;
+    language: string;
+    copyright: ICopyright;
+    tags: string[];
+    audioType?: string;
+    podcastMeta?: INewPodcastMeta;
+    seriesId?: number;
+    manuscript?: string;
+}
+export interface INewPodcastMeta {
+    introduction: string;
+    coverPhotoId: string;
+    coverPhotoAltText: string;
+}
+export interface INewSeries {
+    title: string;
+    description: string;
+    coverPhotoId: string;
+    coverPhotoAltText: string;
+    episodes: number[];
+    language: string;
+    revision?: number;
+    hasRSS?: boolean;
+}
+export interface IPodcastMeta {
+    introduction: string;
+    coverPhoto: ICoverPhoto;
+    language: string;
+}
+export interface ISearchParams {
+    query?: string;
+    license?: string;
+    language?: string;
+    page?: number;
+    pageSize?: number;
+    sort?: string;
+    scrollId?: string;
+    audioType?: string;
+    filterBySeries?: boolean;
+    fallback?: boolean;
+}
+export interface ISeries {
+    id: number;
+    revision: number;
+    title: ITitle;
+    description: IDescription;
+    coverPhoto: ICoverPhoto;
+    episodes?: IAudioMetaInformation[];
+    supportedLanguages: string[];
+    hasRSS: boolean;
+}
+export interface ISeriesSearchParams {
+    query?: string;
+    language?: string;
+    page?: number;
+    pageSize?: number;
+    sort?: string;
+    scrollId?: string;
+    fallback?: boolean;
+}
+export interface ISeriesSummary {
+    id: number;
+    title: ITitle;
+    description: IDescription;
+    supportedLanguages: string[];
+    episodes?: IAudioSummary[];
+    coverPhoto: ICoverPhoto;
+}
+export interface ISeriesSummarySearchResult {
+    totalCount: number;
+    page?: number;
+    pageSize: number;
+    language: string;
+    results: ISeriesSummary[];
+}
+export interface ITag {
+    tags: string[];
+    language: string;
+}
+export interface ITagsSearchResult {
+    totalCount: number;
+    page: number;
+    pageSize: number;
+    language: string;
+    results: string[];
+}
+export interface ITitle {
+    title: string;
+    language: string;
+}
+export interface IUpdatedAudioMetaInformation {
+    revision: number;
+    title: string;
+    language: string;
+    copyright: ICopyright;
+    tags: string[];
+    audioType?: string;
+    podcastMeta?: INewPodcastMeta;
+    seriesId?: number;
+    manuscript?: string;
+}
+export interface IValidationError {
+    code: string;
+    description: string;
+    messages: IValidationMessage[];
+    occuredAt: string;
+}
+export interface IValidationMessage {
+    field: string;
+    message: string;
+}

package/build/audio-api.js

@@ -0,0 +1,4 @@
+"use strict";
+// DO NOT EDIT: generated file by scala-tsi
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=audio-api.js.map

package/build/audio-api.js.map

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

package/build/concept-api.d.ts

@@ -0,0 +1,178 @@
+export interface IAuthor {
+    type: string;
+    name: string;
+}
+export interface IConcept {
+    id: number;
+    revision: number;
+    title: IConceptTitle;
+    content?: IConceptContent;
+    copyright?: ICopyright;
+    source?: string;
+    metaImage?: IConceptMetaImage;
+    tags?: IConceptTags;
+    subjectIds?: string[];
+    created: string;
+    updated: string;
+    updatedBy?: string[];
+    supportedLanguages: string[];
+    articleIds: number[];
+    status: IStatus;
+    visualElement?: IVisualElement;
+    responsible?: IConceptResponsible;
+}
+export interface IConceptContent {
+    content: string;
+    language: string;
+}
+export interface IConceptMetaImage {
+    url: string;
+    alt: string;
+    language: string;
+}
+export interface IConceptResponsible {
+    responsibleId: string;
+    lastUpdated: string;
+}
+export interface IConceptSearchParams {
+    query?: string;
+    language?: string;
+    page?: number;
+    pageSize?: number;
+    idList: number[];
+    sort?: string;
+    fallback?: boolean;
+    scrollId?: string;
+    subjects: string[];
+    tags: string[];
+    exactTitleMatch?: boolean;
+    embedResource?: string;
+    embedId?: string;
+}
+export interface IConceptSearchResult {
+    totalCount: number;
+    page?: number;
+    pageSize: number;
+    language: string;
+    results: IConceptSummary[];
+}
+export interface IConceptSummary {
+    id: number;
+    title: IConceptTitle;
+    content: IConceptContent;
+    metaImage: IConceptMetaImage;
+    tags?: IConceptTags;
+    subjectIds?: string[];
+    supportedLanguages: string[];
+    lastUpdated: string;
+    created: string;
+    status: IStatus;
+    updatedBy: string[];
+    license?: string;
+    copyright?: ICopyright;
+    visualElement?: IVisualElement;
+    articleIds: number[];
+    source?: string;
+    responsible?: IConceptResponsible;
+}
+export interface IConceptTags {
+    tags: string[];
+    language: string;
+}
+export interface IConceptTitle {
+    title: string;
+    language: string;
+}
+export interface ICopyright {
+    license?: ILicense;
+    origin?: string;
+    creators: IAuthor[];
+    processors: IAuthor[];
+    rightsholders: IAuthor[];
+    agreementId?: number;
+    validFrom?: string;
+    validTo?: string;
+}
+export interface IDraftConceptSearchParams {
+    query?: string;
+    language?: string;
+    page?: number;
+    pageSize?: number;
+    idList: number[];
+    sort?: string;
+    fallback?: boolean;
+    scrollId?: string;
+    subjects: string[];
+    tags: string[];
+    status: string[];
+    users: string[];
+    embedResource?: string;
+    embedId?: string;
+    responsibleIds: string[];
+}
+export interface ILicense {
+    license: string;
+    description?: string;
+    url?: string;
+}
+export interface INewConcept {
+    language: string;
+    title: string;
+    content?: string;
+    copyright?: ICopyright;
+    source?: string;
+    metaImage?: INewConceptMetaImage;
+    tags?: string[];
+    subjectIds?: string[];
+    articleIds?: number[];
+    visualElement?: string;
+    responsibleId?: string;
+}
+export interface INewConceptMetaImage {
+    id: string;
+    alt: string;
+}
+export interface IStatus {
+    current: string;
+    other: string[];
+}
+export interface ISubjectTags {
+    subjectId: string;
+    tags: string[];
+    language: string;
+}
+export interface ITagsSearchResult {
+    totalCount: number;
+    page: number;
+    pageSize: number;
+    language: string;
+    results: string[];
+}
+export interface IUpdatedConcept {
+    language: string;
+    title?: string;
+    content?: string;
+    metaImage?: (null | INewConceptMetaImage);
+    copyright?: ICopyright;
+    source?: string;
+    tags?: string[];
+    subjectIds?: string[];
+    articleIds?: number[];
+    status?: string;
+    visualElement?: string;
+    responsibleId?: (null | string);
+}
+export interface IValidationError {
+    code: string;
+    description: string;
+    messages: IValidationMessage[];
+    occuredAt: string;
+}
+export interface IValidationMessage {
+    field: string;
+    message: string;
+}
+export interface IVisualElement {
+    visualElement: string;
+    language: string;
+}

package/build/concept-api.js

@@ -0,0 +1,4 @@
+"use strict";
+// DO NOT EDIT: generated file by scala-tsi
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=concept-api.js.map

package/build/concept-api.js.map

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