@ndla/types-backend 0.1.1

package/build/learningpath-api.d.ts

@@ -0,0 +1,194 @@
+export interface IAuthor {
+    type: string;
+    name: string;
+}
+export interface IBreadcrumb {
+    id: string;
+    name: string;
+}
+export interface IConfigMeta {
+    key: string;
+    value: string;
+    updatedAt: string;
+    updatedBy: string;
+}
+export interface IConfigMetaRestricted {
+    key: string;
+    value: string;
+}
+export interface ICopyright {
+    license: ILicense;
+    contributors: IAuthor[];
+}
+export interface ICoverPhoto {
+    url: string;
+    metaUrl: string;
+}
+export interface IDescription {
+    description: string;
+    language: string;
+}
+export interface IEmbedUrlV2 {
+    url: string;
+    embedType: string;
+}
+export interface IError {
+    code: string;
+    description: string;
+    occuredAt: string;
+}
+export interface IFolder {
+    id: string;
+    name: string;
+    status: string;
+    parentId?: string;
+    breadcrumbs: IBreadcrumb[];
+    subfolders: IFolderData[];
+    resources: IResource[];
+    rank?: number;
+    created: string;
+    updated: string;
+    shared?: string;
+}
+export type IFolderData = IFolder;
+export interface IIntroduction {
+    introduction: string;
+    language: string;
+}
+export interface ILearningPathStatus {
+    status: string;
+}
+export interface ILearningPathSummaryV2 {
+    id: number;
+    revision?: number;
+    title: ITitle;
+    description: IDescription;
+    introduction: IIntroduction;
+    metaUrl: string;
+    coverPhotoUrl?: string;
+    duration?: number;
+    status: string;
+    lastUpdated: string;
+    tags: ILearningPathTags;
+    copyright: ICopyright;
+    supportedLanguages: string[];
+    isBasedOn?: number;
+    message?: string;
+}
+export interface ILearningPathTags {
+    tags: string[];
+    language: string;
+}
+export interface ILearningPathTagsSummary {
+    language: string;
+    supportedLanguages: string[];
+    tags: string[];
+}
+export interface ILearningPathV2 {
+    id: number;
+    revision: number;
+    isBasedOn?: number;
+    title: ITitle;
+    description: IDescription;
+    metaUrl: string;
+    learningsteps: ILearningStepV2[];
+    learningstepUrl: string;
+    coverPhoto?: ICoverPhoto;
+    duration?: number;
+    status: string;
+    verificationStatus: string;
+    lastUpdated: string;
+    tags: ILearningPathTags;
+    copyright: ICopyright;
+    canEdit: boolean;
+    supportedLanguages: string[];
+    ownerId?: string;
+    message?: IMessage;
+}
+export interface ILearningStepContainerSummary {
+    language: string;
+    learningsteps: ILearningStepSummaryV2[];
+    supportedLanguages: string[];
+}
+export interface ILearningStepSeqNo {
+    seqNo: number;
+}
+export interface ILearningStepStatus {
+    status: string;
+}
+export interface ILearningStepSummaryV2 {
+    id: number;
+    seqNo: number;
+    title: ITitle;
+    type: string;
+    metaUrl: string;
+}
+export interface ILearningStepV2 {
+    id: number;
+    revision: number;
+    seqNo: number;
+    title: ITitle;
+    description?: IDescription;
+    embedUrl?: IEmbedUrlV2;
+    showTitle: boolean;
+    type: string;
+    license?: ILicense;
+    metaUrl: string;
+    canEdit: boolean;
+    status: string;
+    supportedLanguages: string[];
+}
+export interface ILicense {
+    license: string;
+    description?: string;
+    url?: string;
+}
+export interface IMessage {
+    message: string;
+    date: string;
+}
+export interface IMyNDLAUser {
+    id: number;
+    favoriteSubjects: string[];
+    role: string;
+    organization: string;
+}
+export interface INewFolder {
+    name: string;
+    parentId?: string;
+    status?: string;
+}
+export interface INewResource {
+    resourceType: string;
+    path: string;
+    tags?: string[];
+    resourceId: string;
+}
+export interface IResource {
+    id: string;
+    resourceType: string;
+    path: string;
+    created: string;
+    tags: string[];
+    resourceId: string;
+    rank?: number;
+}
+export interface ISearchResultV2 {
+    totalCount: number;
+    page?: number;
+    pageSize: number;
+    language: string;
+    results: ILearningPathSummaryV2[];
+}
+export interface ITitle {
+    title: string;
+    language: string;
+}
+export interface IUpdatedFolder {
+    name?: string;
+    status?: string;
+}
+export interface IUpdatedResource {
+    tags?: string[];
+    resourceId?: string;
+}

package/build/learningpath-api.js

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

package/build/learningpath-api.js.map

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

package/build/search-api.d.ts

@@ -0,0 +1,200 @@
+export interface IApiTaxonomyContext {
+    id: string;
+    subject: string;
+    subjectId: string;
+    relevance: string;
+    path: string;
+    breadcrumbs: string[];
+    filters: ITaxonomyContextFilter[];
+    learningResourceType: string;
+    resourceTypes: ITaxonomyResourceType[];
+    language: string;
+    isPrimaryConnection: boolean;
+}
+export interface IArticleIntroduction {
+    introduction: string;
+    language: string;
+}
+export interface IArticleResult {
+    id: number;
+    title: ITitle;
+    introduction?: IArticleIntroduction;
+    articleType: string;
+    supportedLanguages: string[];
+}
+export interface IArticleResults {
+    type: string;
+    language: string;
+    totalCount: number;
+    page: number;
+    pageSize: number;
+    results: IArticleResult[];
+}
+export interface IAudioResult {
+    id: number;
+    title: ITitle;
+    url: string;
+    supportedLanguages: string[];
+}
+export interface IAudioResults {
+    type: string;
+    language: string;
+    totalCount: number;
+    page: number;
+    pageSize: number;
+    results: IAudioResult[];
+}
+export interface IDraftResponsible {
+    responsibleId: string;
+    lastUpdated: string;
+}
+export interface IGroupSearchResult {
+    totalCount: number;
+    page?: number;
+    pageSize: number;
+    language: string;
+    results: IMultiSearchSummary[];
+    suggestions: IMultiSearchSuggestion[];
+    aggregations: IMultiSearchTermsAggregation[];
+    resourceType: string;
+}
+export interface IHighlightedField {
+    field: string;
+    matches: string[];
+}
+export interface IImageAltText {
+    altText: string;
+    language: string;
+}
+export interface IImageResult {
+    id: number;
+    title: ITitle;
+    altText: IImageAltText;
+    previewUrl: string;
+    metaUrl: string;
+    supportedLanguages: string[];
+}
+export interface IImageResults {
+    type: string;
+    language: string;
+    totalCount: number;
+    page: number;
+    pageSize: number;
+    results: IImageResult[];
+}
+export interface ILearningPathIntroduction {
+    introduction: string;
+    language: string;
+}
+export interface ILearningpathResult {
+    id: number;
+    title: ITitle;
+    introduction: ILearningPathIntroduction;
+    supportedLanguages: string[];
+}
+export interface ILearningpathResults {
+    type: string;
+    language: string;
+    totalCount: number;
+    page: number;
+    pageSize: number;
+    results: ILearningpathResult[];
+}
+export interface IMetaDescription {
+    metaDescription: string;
+    language: string;
+}
+export interface IMetaImage {
+    url: string;
+    alt: string;
+    language: string;
+}
+export interface IMultiSearchResult {
+    totalCount: number;
+    page?: number;
+    pageSize: number;
+    language: string;
+    results: IMultiSearchSummary[];
+    suggestions: IMultiSearchSuggestion[];
+    aggregations: IMultiSearchTermsAggregation[];
+}
+export interface IMultiSearchSuggestion {
+    name: string;
+    suggestions: ISearchSuggestion[];
+}
+export interface IMultiSearchSummary {
+    id: number;
+    title: ITitle;
+    metaDescription: IMetaDescription;
+    metaImage?: IMetaImage;
+    url: string;
+    contexts: IApiTaxonomyContext[];
+    supportedLanguages: string[];
+    learningResourceType: string;
+    status?: IStatus;
+    traits: string[];
+    score: number;
+    highlights: IHighlightedField[];
+    paths: string[];
+    lastUpdated: string;
+    license?: string;
+    revisions: IRevisionMeta[];
+    responsible?: IDraftResponsible;
+}
+export interface IMultiSearchTermsAggregation {
+    field: string;
+    sumOtherDocCount: number;
+    docCountErrorUpperBound: number;
+    values: ITermValue[];
+}
+export interface IRevisionMeta {
+    revisionDate: string;
+    note: string;
+    status: string;
+}
+export interface ISearchError {
+    type: string;
+    errorMsg: string;
+}
+export interface ISearchSuggestion {
+    text: string;
+    offset: number;
+    length: number;
+    options: ISuggestOption[];
+}
+export interface IStatus {
+    current: string;
+    other: string[];
+}
+export interface ISuggestOption {
+    text: string;
+    score: number;
+}
+export interface ITaxonomyContextFilter {
+    id: string;
+    name: string;
+    relevance: string;
+}
+export interface ITaxonomyResourceType {
+    id: string;
+    name: string;
+    language: string;
+}
+export interface ITermValue {
+    value: string;
+    count: number;
+}
+export interface ITitle {
+    title: string;
+    language: string;
+}
+export interface IValidationError {
+    code: string;
+    description: string;
+    messages: IValidationMessage[];
+    occuredAt: string;
+}
+export interface IValidationMessage {
+    field: string;
+    message: string;
+}

package/build/search-api.js

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

package/build/search-api.js.map

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

package/package.json

@@ -0,0 +1,26 @@
+{
+    "name": "@ndla/types-backend",
+    "description": "Typescript type definitions for NDLA backend",
+    "license": "GPL-3.0",
+    "scripts": {
+        "build": "tsc",
+        "do-publish": "tsc"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/NDLANO/backend.git",
+        "directory": "typescript"
+    },
+    "author": "ndla@knowit.no",
+    "files": [
+        "lib",
+        "src",
+        "es",
+        "types",
+        "build"
+    ],
+    "devDependencies": {
+        "typescript": "^5.0.2"
+    },
+    "version": "0.1.1"
+}