@ndla/types-backend 0.1.1

package/build/draft-api.d.ts

@@ -0,0 +1,255 @@
+export type Availability = ("everyone" | "teacher");
+export interface IAgreement {
+    id: number;
+    title: string;
+    content: string;
+    copyright: ICopyright;
+    created: string;
+    updated: string;
+    updatedBy: string;
+}
+export interface IAgreementSearchResult {
+    totalCount: number;
+    page?: number;
+    pageSize: number;
+    language: string;
+    results: IAgreementSummary[];
+}
+export interface IAgreementSummary {
+    id: number;
+    title: string;
+    license: string;
+}
+export interface IArticle {
+    id: number;
+    oldNdlaUrl?: string;
+    revision: number;
+    status: IStatus;
+    title?: IArticleTitle;
+    content?: IArticleContent;
+    copyright?: ICopyright;
+    tags?: IArticleTag;
+    requiredLibraries: IRequiredLibrary[];
+    visualElement?: IVisualElement;
+    introduction?: IArticleIntroduction;
+    metaDescription?: IArticleMetaDescription;
+    metaImage?: IArticleMetaImage;
+    created: string;
+    updated: string;
+    updatedBy: string;
+    published: string;
+    articleType: string;
+    supportedLanguages: string[];
+    notes: IEditorNote[];
+    editorLabels: string[];
+    grepCodes: string[];
+    conceptIds: number[];
+    availability: string;
+    relatedContent: (IRelatedContentLink | number)[];
+    revisions: IRevisionMeta[];
+    responsible?: IDraftResponsible;
+    slug?: string;
+}
+export interface IArticleContent {
+    content: string;
+    language: 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 IArticleSummary {
+    id: number;
+    title: IArticleTitle;
+    visualElement?: IVisualElement;
+    introduction?: IArticleIntroduction;
+    url: string;
+    license: string;
+    articleType: string;
+    supportedLanguages: string[];
+    tags?: IArticleTag;
+    notes: string[];
+    users: string[];
+    grepCodes: string[];
+    status: IStatus;
+    updated: string;
+}
+export interface IArticleTag {
+    tags: string[];
+    language: string;
+}
+export interface IArticleTitle {
+    title: string;
+    language: 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 IDraftResponsible {
+    responsibleId: string;
+    lastUpdated: string;
+}
+export interface IEditorNote {
+    note: string;
+    user: string;
+    status: IStatus;
+    timestamp: string;
+}
+export interface IGrepCodesSearchResult {
+    totalCount: number;
+    page: number;
+    pageSize: number;
+    results: string[];
+}
+export interface ILicense {
+    license: string;
+    description?: string;
+    url?: string;
+}
+export interface INewAgreement {
+    title: string;
+    content: string;
+    copyright: INewAgreementCopyright;
+}
+export interface INewAgreementCopyright {
+    license?: ILicense;
+    origin?: string;
+    creators: IAuthor[];
+    processors: IAuthor[];
+    rightsholders: IAuthor[];
+    agreementId?: number;
+    validFrom?: string;
+    validTo?: string;
+}
+export interface INewArticle {
+    language: string;
+    title: string;
+    published?: string;
+    content?: string;
+    tags: string[];
+    introduction?: string;
+    metaDescription?: string;
+    metaImage?: INewArticleMetaImage;
+    visualElement?: string;
+    copyright?: ICopyright;
+    requiredLibraries: IRequiredLibrary[];
+    articleType: string;
+    notes: string[];
+    editorLabels: string[];
+    grepCodes: string[];
+    conceptIds: number[];
+    availability?: string;
+    relatedContent: (IRelatedContentLink | number)[];
+    revisionMeta?: IRevisionMeta[];
+    responsibleId?: string;
+    slug?: string;
+}
+export interface INewArticleMetaImage {
+    id: string;
+    alt: string;
+}
+export interface IRelatedContentLink {
+    title: string;
+    url: string;
+}
+export interface IRequiredLibrary {
+    mediaType: string;
+    name: string;
+    url: string;
+}
+export interface IRevisionMeta {
+    id?: string;
+    revisionDate: string;
+    note: string;
+    status: string;
+}
+export interface ISearchResult {
+    totalCount: number;
+    page: number;
+    pageSize: number;
+    language: string;
+    results: IArticleSummary[];
+}
+export interface IStatus {
+    current: string;
+    other: string[];
+}
+export interface ITagsSearchResult {
+    totalCount: number;
+    page: number;
+    pageSize: number;
+    language: string;
+    results: string[];
+}
+export interface IUpdatedAgreement {
+    title?: string;
+    content?: string;
+    copyright?: INewAgreementCopyright;
+}
+export interface IUpdatedArticle {
+    revision: number;
+    language?: string;
+    title?: string;
+    status?: string;
+    published?: string;
+    content?: string;
+    tags?: string[];
+    introduction?: string;
+    metaDescription?: string;
+    metaImage?: (null | INewArticleMetaImage);
+    visualElement?: string;
+    copyright?: ICopyright;
+    requiredLibraries?: IRequiredLibrary[];
+    articleType?: string;
+    notes?: string[];
+    editorLabels?: string[];
+    grepCodes?: string[];
+    conceptIds?: number[];
+    createNewVersion?: boolean;
+    availability?: string;
+    relatedContent?: (IRelatedContentLink | number)[];
+    revisionMeta?: IRevisionMeta[];
+    responsibleId?: (null | string);
+    slug?: string;
+}
+export interface IUpdatedUserData {
+    savedSearches?: string[];
+    latestEditedArticles?: string[];
+    favoriteSubjects?: string[];
+}
+export interface IUploadedFile {
+    filename: string;
+    mime: string;
+    extension: string;
+    path: string;
+}
+export interface IUserData {
+    userId: string;
+    savedSearches?: string[];
+    latestEditedArticles?: string[];
+    favoriteSubjects?: string[];
+}
+export interface IVisualElement {
+    visualElement: string;
+    language: string;
+}

package/build/draft-api.js

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

package/build/draft-api.js.map

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

package/build/frontpage-api.d.ts

@@ -0,0 +1,135 @@
+export interface IAboutFilmSubject {
+    title: string;
+    description: string;
+    visualElement: IVisualElement;
+    language: string;
+}
+export interface IAboutSubject {
+    title: string;
+    description: string;
+    visualElement: IVisualElement;
+}
+export interface IBannerImage {
+    mobileUrl?: string;
+    mobileId?: number;
+    desktopUrl: string;
+    desktopId: number;
+}
+export interface IErrorBody {
+    code: string;
+    description: string;
+    occuredAt: string;
+}
+export interface IFilmFrontPageData {
+    name: string;
+    about: IAboutFilmSubject[];
+    movieThemes: IMovieTheme[];
+    slideShow: string[];
+}
+export interface IFrontPageData {
+    topical: string[];
+    categories: ISubjectCollection[];
+}
+export interface IMovieTheme {
+    name: IMovieThemeName[];
+    movies: string[];
+}
+export interface IMovieThemeName {
+    name: string;
+    language: string;
+}
+export interface INewOrUpdateBannerImage {
+    mobileImageId?: number;
+    desktopImageId: number;
+}
+export interface INewOrUpdatedAboutSubject {
+    title: string;
+    description: string;
+    language: string;
+    visualElement: INewOrUpdatedVisualElement;
+}
+export interface INewOrUpdatedFilmFrontPageData {
+    name: string;
+    about: INewOrUpdatedAboutSubject[];
+    movieThemes: INewOrUpdatedMovieTheme[];
+    slideShow: string[];
+}
+export interface INewOrUpdatedMetaDescription {
+    metaDescription: string;
+    language: string;
+}
+export interface INewOrUpdatedMovieName {
+    name: string;
+    language: string;
+}
+export interface INewOrUpdatedMovieTheme {
+    name: INewOrUpdatedMovieName[];
+    movies: string[];
+}
+export interface INewOrUpdatedVisualElement {
+    type: string;
+    id: string;
+    alt?: string;
+}
+export interface INewSubjectFrontPageData {
+    name: string;
+    filters?: string[];
+    externalId?: string;
+    layout: string;
+    twitter?: string;
+    facebook?: string;
+    banner: INewOrUpdateBannerImage;
+    about: INewOrUpdatedAboutSubject[];
+    metaDescription: INewOrUpdatedMetaDescription[];
+    topical?: string;
+    mostRead?: string[];
+    editorsChoices?: string[];
+    latestContent?: string[];
+    goTo?: string[];
+}
+export interface ISubjectCollection {
+    name: string;
+    subjects: ISubjectFilters[];
+}
+export interface ISubjectFilters {
+    id: string;
+    filters: string[];
+}
+export interface ISubjectPageData {
+    id: number;
+    name: string;
+    filters?: string[];
+    layout: string;
+    twitter?: string;
+    facebook?: string;
+    banner: IBannerImage;
+    about?: IAboutSubject;
+    metaDescription?: string;
+    topical?: string;
+    mostRead: string[];
+    editorsChoices: string[];
+    latestContent?: string[];
+    goTo: string[];
+    supportedLanguages: string[];
+}
+export interface IUpdatedSubjectFrontPageData {
+    name?: string;
+    filters?: string[];
+    externalId?: string;
+    layout?: string;
+    twitter?: string;
+    facebook?: string;
+    banner?: INewOrUpdateBannerImage;
+    about?: INewOrUpdatedAboutSubject[];
+    metaDescription?: INewOrUpdatedMetaDescription[];
+    topical?: string;
+    mostRead?: string[];
+    editorsChoices?: string[];
+    latestContent?: string[];
+    goTo?: string[];
+}
+export interface IVisualElement {
+    type: string;
+    url: string;
+    alt?: string;
+}

package/build/frontpage-api.js

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

package/build/frontpage-api.js.map

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

package/build/image-api.d.ts

@@ -0,0 +1,169 @@
+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 IEditorNote {
+    timestamp: string;
+    updatedBy: string;
+    note: string;
+}
+export interface IImage {
+    url: string;
+    size: number;
+    contentType: string;
+}
+export interface IImageAltText {
+    alttext: string;
+    language: string;
+}
+export interface IImageCaption {
+    caption: string;
+    language: string;
+}
+export interface IImageDimensions {
+    width: number;
+    height: number;
+}
+export interface IImageFile {
+    fileName: string;
+    size: number;
+    contentType: string;
+    imageUrl: string;
+    dimensions?: IImageDimensions;
+    language: string;
+}
+export interface IImageMetaInformationV2 {
+    id: string;
+    metaUrl: string;
+    title: IImageTitle;
+    alttext: IImageAltText;
+    imageUrl: string;
+    size: number;
+    contentType: string;
+    copyright: ICopyright;
+    tags: IImageTag;
+    caption: IImageCaption;
+    supportedLanguages: string[];
+    created: string;
+    createdBy: string;
+    modelRelease: string;
+    editorNotes?: IEditorNote[];
+    imageDimensions?: IImageDimensions;
+}
+export interface IImageMetaInformationV3 {
+    id: string;
+    metaUrl: string;
+    title: IImageTitle;
+    alttext: IImageAltText;
+    copyright: ICopyright;
+    tags: IImageTag;
+    caption: IImageCaption;
+    supportedLanguages: string[];
+    created: string;
+    createdBy: string;
+    modelRelease: string;
+    editorNotes?: IEditorNote[];
+    image: IImageFile;
+}
+export interface IImageMetaSummary {
+    id: string;
+    title: IImageTitle;
+    contributors: string[];
+    altText: IImageAltText;
+    caption: IImageCaption;
+    previewUrl: string;
+    metaUrl: string;
+    license: string;
+    supportedLanguages: string[];
+    modelRelease?: string;
+    editorNotes?: string[];
+    lastUpdated: string;
+    fileSize: number;
+    contentType: string;
+    imageDimensions?: IImageDimensions;
+}
+export interface IImageTag {
+    tags: string[];
+    language: string;
+}
+export interface IImageTitle {
+    title: string;
+    language: string;
+}
+export interface ILicense {
+    license: string;
+    description: string;
+    url?: string;
+}
+export interface INewImageMetaInformationV2 {
+    title: string;
+    alttext?: string;
+    copyright: ICopyright;
+    tags: string[];
+    caption: string;
+    language: string;
+    modelReleased?: string;
+}
+export interface ISearchParams {
+    query?: string;
+    license?: string;
+    language?: string;
+    fallback?: boolean;
+    minimumSize?: number;
+    includeCopyrighted?: boolean;
+    sort?: string;
+    page?: number;
+    pageSize?: number;
+    scrollId?: string;
+    modelReleased?: string[];
+}
+export interface ISearchResult {
+    totalCount: number;
+    page?: number;
+    pageSize: number;
+    language: string;
+    results: IImageMetaSummary[];
+}
+export interface ISearchResultV3 {
+    totalCount: number;
+    page?: number;
+    pageSize: number;
+    language: string;
+    results: IImageMetaInformationV3[];
+}
+export interface ITagsSearchResult {
+    totalCount: number;
+    page: number;
+    pageSize: number;
+    language: string;
+    results: string[];
+}
+export interface IUpdateImageMetaInformation {
+    language: string;
+    title?: string;
+    alttext?: (null | string);
+    copyright?: ICopyright;
+    tags?: string[];
+    caption?: string;
+    modelReleased?: string;
+}
+export interface IValidationError {
+    code: string;
+    description: string;
+    messages: IValidationMessage[];
+    occurredAt: string;
+}
+export interface IValidationMessage {
+    field: string;
+    message: string;
+}

package/build/image-api.js

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

package/build/image-api.js.map

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