@valtimo/document 4.15.3-next-main.16 → 4.16.0-next-main.19

package/lib/document-search-request.d.ts

@@ -1,50 +1,50 @@
-import { HttpParams } from '@angular/common/http';
-import { SortState } from '@valtimo/contract';
-export interface DocumentSearchRequest {
-    definitionName: string;
-    page: number;
-    size: number;
-    sequence?: number;
-    createdBy?: string;
-    globalSearchFilter?: string;
-    sort?: SortState;
-    searchCriteria?: Array<{
-        path: string;
-        value: string;
-    }>;
-    asHttpBody(): DocumentSearchRequestHttpBody;
-    asHttpParams(): HttpParams;
-    setPage(page: number): void;
-    getSortString(sort: SortState): string;
-}
-export declare class DocumentSearchRequestHttpBody {
-    documentDefinitionName?: string;
-    sequence?: number;
-    createdBy?: string;
-    globalSearchFilter?: string;
-    otherFilters?: Array<{
-        path: string;
-        value: string;
-    }>;
-}
-export declare class DocumentSearchRequestImpl implements DocumentSearchRequest {
-    definitionName: string;
-    page: number;
-    size: number;
-    sequence?: number;
-    createdBy?: string;
-    globalSearchFilter?: string;
-    sort?: SortState;
-    otherFilters?: Array<{
-        path: string;
-        value: string;
-    }>;
-    constructor(definitionName: string, page: number, size: number, sequence?: number, createdBy?: string, globalSearchFilter?: string, sort?: SortState, otherFilters?: Array<{
-        path: string;
-        value: string;
-    }>);
-    asHttpBody(): DocumentSearchRequestHttpBody;
-    asHttpParams(): HttpParams;
-    setPage(page: number): void;
-    getSortString(sort: SortState): string;
-}
+import { HttpParams } from '@angular/common/http';
+import { SortState } from './models';
+export interface DocumentSearchRequest {
+    definitionName: string;
+    page: number;
+    size: number;
+    sequence?: number;
+    createdBy?: string;
+    globalSearchFilter?: string;
+    sort?: SortState;
+    searchCriteria?: Array<{
+        path: string;
+        value: string;
+    }>;
+    asHttpBody(): DocumentSearchRequestHttpBody;
+    asHttpParams(): HttpParams;
+    setPage(page: number): void;
+    getSortString(sort: SortState): string;
+}
+export declare class DocumentSearchRequestHttpBody {
+    documentDefinitionName?: string;
+    sequence?: number;
+    createdBy?: string;
+    globalSearchFilter?: string;
+    otherFilters?: Array<{
+        path: string;
+        value: string;
+    }>;
+}
+export declare class DocumentSearchRequestImpl implements DocumentSearchRequest {
+    definitionName: string;
+    page: number;
+    size: number;
+    sequence?: number;
+    createdBy?: string;
+    globalSearchFilter?: string;
+    sort?: SortState;
+    otherFilters?: Array<{
+        path: string;
+        value: string;
+    }>;
+    constructor(definitionName: string, page: number, size: number, sequence?: number, createdBy?: string, globalSearchFilter?: string, sort?: SortState, otherFilters?: Array<{
+        path: string;
+        value: string;
+    }>);
+    asHttpBody(): DocumentSearchRequestHttpBody;
+    asHttpParams(): HttpParams;
+    setPage(page: number): void;
+    getSortString(sort: SortState): string;
+}

package/lib/document.module.d.ts

@@ -1,2 +1,2 @@
-export declare class DocumentModule {
-}
+export declare class DocumentModule {
+}

package/lib/document.service.d.ts

@@ -1,30 +1,30 @@
-import { HttpClient } from '@angular/common/http';
-import { Observable } from 'rxjs';
-import { AuditRecord, Document, DocumentDefinition, DocumentDefinitions, DocumentResult, Documents, ModifyDocumentAndCompleteTaskRequestImpl, ModifyDocumentAndCompleteTaskResult, ModifyDocumentAndStartProcessRequestImpl, ModifyDocumentAndStartProcessResult, NewDocumentAndStartProcessRequestImpl, NewDocumentAndStartProcessResult, Page, ProcessDocumentDefinition, ProcessDocumentDefinitionRequest, ProcessDocumentInstance, DocumentDefinitionCreateRequest, UndeployDocumentDefinitionResult, DocumentSendMessageRequest } from '@valtimo/contract';
-import { DocumentSearchRequest } from './document-search-request';
-import { ConfigService } from '@valtimo/config';
-export declare class DocumentService {
-    private http;
-    private valtimoEndpointUri;
-    constructor(http: HttpClient, configService: ConfigService);
-    getAllDefinitions(): Observable<DocumentDefinitions>;
-    queryDefinitions(params?: any): Observable<Page<DocumentDefinition>>;
-    getDocumentDefinition(documentDefinitionName: string): Observable<DocumentDefinition>;
-    getDocuments(documentSearchRequest: DocumentSearchRequest): Observable<Documents>;
-    getDocument(documentId: string): Observable<Document>;
-    modifyDocument(document: any): Observable<DocumentResult>;
-    getProcessDocumentDefinitions(): Observable<ProcessDocumentDefinition>;
-    findProcessDocumentDefinitions(documentDefinitionName: string): Observable<ProcessDocumentDefinition[]>;
-    findProcessDocumentInstances(documentId: string): Observable<ProcessDocumentInstance[]>;
-    newDocumentAndStartProcess(request: NewDocumentAndStartProcessRequestImpl): Observable<NewDocumentAndStartProcessResult>;
-    modifyDocumentAndCompleteTask(request: ModifyDocumentAndCompleteTaskRequestImpl): Observable<ModifyDocumentAndCompleteTaskResult>;
-    modifyDocumentAndStartProcess(request: ModifyDocumentAndStartProcessRequestImpl): Observable<ModifyDocumentAndStartProcessResult>;
-    createProcessDocumentDefinition(request: ProcessDocumentDefinitionRequest): Observable<ProcessDocumentDefinition>;
-    createDocumentDefinition(documentDefinitionCreateRequest: DocumentDefinitionCreateRequest): Observable<void>;
-    deleteProcessDocumentDefinition(request: ProcessDocumentDefinitionRequest): Observable<any>;
-    getAuditLog(documentId: string, page?: number): Observable<Page<AuditRecord>>;
-    assignResource(documentId: string, resourceId: string): Observable<void>;
-    removeResource(documentId: string, resourceId: string): Observable<void>;
-    removeDocumentDefinition(name: string): Observable<UndeployDocumentDefinitionResult>;
-    sendMessage(documentId: string, request: DocumentSendMessageRequest): Observable<any>;
-}
+import { HttpClient } from '@angular/common/http';
+import { Observable } from 'rxjs';
+import { AuditRecord, Document, DocumentDefinition, DocumentDefinitions, DocumentResult, Documents, ModifyDocumentAndCompleteTaskRequestImpl, ModifyDocumentAndCompleteTaskResult, ModifyDocumentAndStartProcessRequestImpl, ModifyDocumentAndStartProcessResult, NewDocumentAndStartProcessRequestImpl, NewDocumentAndStartProcessResult, Page, ProcessDocumentDefinition, ProcessDocumentDefinitionRequest, ProcessDocumentInstance, DocumentDefinitionCreateRequest, UndeployDocumentDefinitionResult, DocumentSendMessageRequest } from './models';
+import { DocumentSearchRequest } from './document-search-request';
+import { ConfigService } from '@valtimo/config';
+export declare class DocumentService {
+    private http;
+    private valtimoEndpointUri;
+    constructor(http: HttpClient, configService: ConfigService);
+    getAllDefinitions(): Observable<DocumentDefinitions>;
+    queryDefinitions(params?: any): Observable<Page<DocumentDefinition>>;
+    getDocumentDefinition(documentDefinitionName: string): Observable<DocumentDefinition>;
+    getDocuments(documentSearchRequest: DocumentSearchRequest): Observable<Documents>;
+    getDocument(documentId: string): Observable<Document>;
+    modifyDocument(document: any): Observable<DocumentResult>;
+    getProcessDocumentDefinitions(): Observable<ProcessDocumentDefinition>;
+    findProcessDocumentDefinitions(documentDefinitionName: string): Observable<ProcessDocumentDefinition[]>;
+    findProcessDocumentInstances(documentId: string): Observable<ProcessDocumentInstance[]>;
+    newDocumentAndStartProcess(request: NewDocumentAndStartProcessRequestImpl): Observable<NewDocumentAndStartProcessResult>;
+    modifyDocumentAndCompleteTask(request: ModifyDocumentAndCompleteTaskRequestImpl): Observable<ModifyDocumentAndCompleteTaskResult>;
+    modifyDocumentAndStartProcess(request: ModifyDocumentAndStartProcessRequestImpl): Observable<ModifyDocumentAndStartProcessResult>;
+    createProcessDocumentDefinition(request: ProcessDocumentDefinitionRequest): Observable<ProcessDocumentDefinition>;
+    createDocumentDefinition(documentDefinitionCreateRequest: DocumentDefinitionCreateRequest): Observable<void>;
+    deleteProcessDocumentDefinition(request: ProcessDocumentDefinitionRequest): Observable<any>;
+    getAuditLog(documentId: string, page?: number): Observable<Page<AuditRecord>>;
+    assignResource(documentId: string, resourceId: string): Observable<void>;
+    removeResource(documentId: string, resourceId: string): Observable<void>;
+    removeDocumentDefinition(name: string): Observable<UndeployDocumentDefinitionResult>;
+    sendMessage(documentId: string, request: DocumentSendMessageRequest): Observable<any>;
+}

package/lib/models/audit.model.d.ts

@@ -0,0 +1,18 @@
+export interface AuditEvent {
+    className: string;
+    id: string;
+    origin: string;
+    occurredOn: Date;
+    user: string;
+}
+export interface MetaData {
+    id: any;
+    origin: string;
+    occurredOn: Date;
+    user: string;
+}
+export interface AuditRecord {
+    metaData: MetaData;
+    createdOn: Date;
+    auditEvent: AuditEvent;
+}

package/lib/models/document.model.d.ts

@@ -0,0 +1,178 @@
+export interface SortResult {
+    sorted: boolean;
+    unsorted: boolean;
+}
+export interface Pageable {
+    sort: SortResult;
+    pageSize: number;
+    pageNumber: number;
+    offset: number;
+    unpaged: boolean;
+    paged: boolean;
+}
+export interface Page<T> {
+    content: Array<T>;
+    pageable: Pageable;
+    last: boolean;
+    totalPages: number;
+    totalElements: number;
+    first: boolean;
+    sort: SortResult;
+    numberOfElements: number;
+    size: number;
+    number: number;
+}
+export interface DocumentDefinitions {
+    content: DocumentDefinition[];
+    empty: boolean;
+    first: boolean;
+    last: boolean;
+    number: number;
+    numberOfElements: number;
+    size: number;
+    sort: any;
+    totalElements: number;
+    totalPages: number;
+}
+export interface DocumentDefinition {
+    id: DefinitionId;
+    schema: any;
+    createdOn: string;
+    readOnly: boolean;
+}
+export interface DefinitionId {
+    name: string;
+    version: number;
+}
+export interface Documents {
+    content: Document[];
+    empty: boolean;
+    first: boolean;
+    last: boolean;
+    number: number;
+    numberOfElements: number;
+    size: number;
+    sort: any;
+    totalElements: number;
+    totalPages: number;
+}
+export interface RelatedFile {
+    fileId: string;
+    fileName: string;
+    sizeInBytes: number;
+    createdOn: Date;
+    createdBy: string;
+}
+export interface Document {
+    id: string;
+    content: object;
+    version: string;
+    createdOn: Date;
+    modifiedOn: Date;
+    createdBy: string;
+    sequence: number;
+    definitionName: string;
+    relations: string[];
+    relatedFiles: RelatedFile[];
+}
+export interface ProcessDocumentDefinitionId {
+    processDefinitionKey: string;
+    documentDefinitionId: DefinitionId;
+}
+export interface ProcessDocumentDefinition {
+    id: ProcessDocumentDefinitionId;
+    processName: string;
+    canInitializeDocument: boolean;
+    startableByUser: boolean;
+}
+export interface ProcessDocumentInstanceId {
+    processInstanceId: string;
+    documentId: string;
+}
+export interface ProcessDocumentInstance {
+    id: ProcessDocumentInstanceId;
+    processName: string;
+}
+export interface NewDocumentAndStartProcessResult {
+    document: Document;
+    processInstanceId: string;
+    errors: string[];
+}
+export interface ModifyDocumentAndCompleteTaskResult {
+    document: Document;
+    errors: string[];
+}
+export interface ModifyDocumentAndStartProcessResult {
+    document: Document;
+    processInstanceId: string;
+    errors: string[];
+}
+export interface DocumentResult {
+    document: Document;
+    errors: string[];
+}
+export interface ModifyDocumentRequest {
+    documentId: string;
+    content: object;
+    versionBasedOn: string;
+}
+export declare class ModifyDocumentRequestImpl implements ModifyDocumentRequest {
+    documentId: string;
+    content: object;
+    versionBasedOn: string;
+    constructor(documentId: string, content: object, versionBasedOn: string);
+}
+export interface ModifyDocumentAndCompleteTaskRequest<T_MODIFY_DOCUMENT_REQUEST extends ModifyDocumentRequest> {
+    taskId: string;
+    request: T_MODIFY_DOCUMENT_REQUEST;
+}
+export declare class ModifyDocumentAndCompleteTaskRequestImpl implements ModifyDocumentAndCompleteTaskRequest<ModifyDocumentRequestImpl> {
+    taskId: string;
+    request: ModifyDocumentRequestImpl;
+    constructor(taskId: string, request: ModifyDocumentRequestImpl);
+}
+export interface NewDocumentRequest {
+    definition: string;
+    content: object;
+}
+export declare class NewDocumentRequestImpl implements NewDocumentRequest {
+    definition: string;
+    content: object;
+    constructor(definition: string, content: object);
+}
+export interface NewDocumentAndStartProcessRequest<T_NEW_DOCUMENT_REQUEST extends NewDocumentRequest> {
+    processDefinitionKey: string;
+    request: T_NEW_DOCUMENT_REQUEST;
+}
+export declare class NewDocumentAndStartProcessRequestImpl implements NewDocumentAndStartProcessRequest<NewDocumentRequestImpl> {
+    processDefinitionKey: string;
+    request: NewDocumentRequestImpl;
+    constructor(processDefinitionKey: string, request: NewDocumentRequestImpl);
+}
+export interface ModifyDocumentAndStartProcessRequest<T_MODIFY_DOCUMENT_REQUEST extends ModifyDocumentRequest> {
+    processDefinitionKey: string;
+    request: T_MODIFY_DOCUMENT_REQUEST;
+}
+export declare class ModifyDocumentAndStartProcessRequestImpl implements ModifyDocumentAndStartProcessRequest<ModifyDocumentRequestImpl> {
+    processDefinitionKey: string;
+    request: ModifyDocumentRequestImpl;
+    constructor(processDefinitionKey: string, request: ModifyDocumentRequestImpl);
+}
+export interface ProcessDocumentDefinitionRequest {
+    processDefinitionKey: string;
+    documentDefinitionName: string;
+    canInitializeDocument: boolean;
+    startableByUser: boolean;
+}
+export declare class DocumentDefinitionCreateRequest {
+    definition: string;
+    constructor(definition: string);
+}
+export interface UndeployDocumentDefinitionResult {
+    documentDefinitionName: string;
+    errors: string[];
+}
+export interface DocumentSendMessageRequest {
+    subject: string;
+    bodyText: string;
+}

package/lib/models/index.d.ts

@@ -0,0 +1,3 @@
+export * from './document.model';
+export * from './list-sorting.model';
+export * from './audit.model';

package/lib/models/list-sorting.model.d.ts

@@ -0,0 +1,9 @@
+export declare type Direction = 'ASC' | 'DESC';
+export interface Sort {
+    name: string;
+    direction: Direction;
+}
+export interface SortState {
+    state: Sort;
+    isSorting: boolean;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@valtimo/document",
   "license": "EUPL-1.2",
-  "version": "4.15.3-next-main.16",
+  "version": "4.16.0-next-main.19",
   "peerDependencies": {
     "@angular/common": "^10.0.11",
     "@angular/core": "^10.0.11"

package/public_api.d.ts

@@ -1,3 +1,4 @@
-export * from './lib/document.service';
-export * from './lib/document.module';
-export * from './lib/document-search-request';
+export * from './lib/models';
+export * from './lib/document.service';
+export * from './lib/document.module';
+export * from './lib/document-search-request';

package/valtimo-document.d.ts

@@ -1,4 +1,5 @@
-/**
- * Generated bundle index. Do not edit.
- */
-export * from './public_api';
+/**
+ * Generated bundle index. Do not edit.
+ */
+export * from './public_api';
+export { SortState as ɵa } from './lib/models';

package/valtimo-document.metadata.json

@@ -1 +1 @@
-{"__symbolic":"module","version":4,"metadata":{"DocumentService":{"__symbolic":"class","decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"Injectable","line":43,"character":1},"arguments":[{"providedIn":"root"}]}],"members":{"__ctor__":[{"__symbolic":"constructor","parameters":[{"__symbolic":"reference","module":"@angular/common/http","name":"HttpClient","line":49,"character":28},{"__symbolic":"reference","module":"@valtimo/config","name":"ConfigService","line":49,"character":55}]}],"getAllDefinitions":[{"__symbolic":"method"}],"queryDefinitions":[{"__symbolic":"method"}],"getDocumentDefinition":[{"__symbolic":"method"}],"getDocuments":[{"__symbolic":"method"}],"getDocument":[{"__symbolic":"method"}],"modifyDocument":[{"__symbolic":"method"}],"getProcessDocumentDefinitions":[{"__symbolic":"method"}],"findProcessDocumentDefinitions":[{"__symbolic":"method"}],"findProcessDocumentInstances":[{"__symbolic":"method"}],"newDocumentAndStartProcess":[{"__symbolic":"method"}],"modifyDocumentAndCompleteTask":[{"__symbolic":"method"}],"modifyDocumentAndStartProcess":[{"__symbolic":"method"}],"createProcessDocumentDefinition":[{"__symbolic":"method"}],"createDocumentDefinition":[{"__symbolic":"method"}],"deleteProcessDocumentDefinition":[{"__symbolic":"method"}],"getAuditLog":[{"__symbolic":"method"}],"assignResource":[{"__symbolic":"method"}],"removeResource":[{"__symbolic":"method"}],"removeDocumentDefinition":[{"__symbolic":"method"}],"sendMessage":[{"__symbolic":"method"}]},"statics":{"ɵprov":{}}},"DocumentModule":{"__symbolic":"class","decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"NgModule","line":18,"character":1}}],"members":{}},"DocumentSearchRequest":{"__symbolic":"interface"},"DocumentSearchRequestHttpBody":{"__symbolic":"class","members":{}},"DocumentSearchRequestImpl":{"__symbolic":"class","members":{"__ctor__":[{"__symbolic":"constructor","parameters":[{"__symbolic":"reference","name":"string"},{"__symbolic":"reference","name":"number"},{"__symbolic":"reference","name":"number"},{"__symbolic":"reference","name":"number"},{"__symbolic":"reference","name":"string"},{"__symbolic":"reference","name":"string"},{"__symbolic":"reference","module":"@valtimo/contract","name":"SortState","line":60,"character":11},{"__symbolic":"reference","name":"Array","arguments":[{"__symbolic":"error","message":"Expression form not supported","line":61,"character":25,"module":"./lib/document-search-request"}]}]}],"asHttpBody":[{"__symbolic":"method"}],"asHttpParams":[{"__symbolic":"method"}],"setPage":[{"__symbolic":"method"}],"getSortString":[{"__symbolic":"method"}]}}},"origins":{"DocumentService":"./lib/document.service","DocumentModule":"./lib/document.module","DocumentSearchRequest":"./lib/document-search-request","DocumentSearchRequestHttpBody":"./lib/document-search-request","DocumentSearchRequestImpl":"./lib/document-search-request"},"importAs":"@valtimo/document"}
+{"__symbolic":"module","version":4,"exports":[{"from":"./lib/document.model"},{"from":"./lib/list-sorting.model"},{"from":"./lib/audit.model"}],"metadata":{"DocumentService":{"__symbolic":"class","decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"Injectable","line":43,"character":1},"arguments":[{"providedIn":"root"}]}],"members":{"__ctor__":[{"__symbolic":"constructor","parameters":[{"__symbolic":"reference","module":"@angular/common/http","name":"HttpClient","line":49,"character":28},{"__symbolic":"reference","module":"@valtimo/config","name":"ConfigService","line":49,"character":55}]}],"getAllDefinitions":[{"__symbolic":"method"}],"queryDefinitions":[{"__symbolic":"method"}],"getDocumentDefinition":[{"__symbolic":"method"}],"getDocuments":[{"__symbolic":"method"}],"getDocument":[{"__symbolic":"method"}],"modifyDocument":[{"__symbolic":"method"}],"getProcessDocumentDefinitions":[{"__symbolic":"method"}],"findProcessDocumentDefinitions":[{"__symbolic":"method"}],"findProcessDocumentInstances":[{"__symbolic":"method"}],"newDocumentAndStartProcess":[{"__symbolic":"method"}],"modifyDocumentAndCompleteTask":[{"__symbolic":"method"}],"modifyDocumentAndStartProcess":[{"__symbolic":"method"}],"createProcessDocumentDefinition":[{"__symbolic":"method"}],"createDocumentDefinition":[{"__symbolic":"method"}],"deleteProcessDocumentDefinition":[{"__symbolic":"method"}],"getAuditLog":[{"__symbolic":"method"}],"assignResource":[{"__symbolic":"method"}],"removeResource":[{"__symbolic":"method"}],"removeDocumentDefinition":[{"__symbolic":"method"}],"sendMessage":[{"__symbolic":"method"}]},"statics":{"ɵprov":{}}},"DocumentModule":{"__symbolic":"class","decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"NgModule","line":18,"character":1}}],"members":{}},"DocumentSearchRequest":{"__symbolic":"interface"},"DocumentSearchRequestHttpBody":{"__symbolic":"class","members":{}},"DocumentSearchRequestImpl":{"__symbolic":"class","members":{"__ctor__":[{"__symbolic":"constructor","parameters":[{"__symbolic":"reference","name":"string"},{"__symbolic":"reference","name":"number"},{"__symbolic":"reference","name":"number"},{"__symbolic":"reference","name":"number"},{"__symbolic":"reference","name":"string"},{"__symbolic":"reference","name":"string"},{"__symbolic":"reference","name":"ɵa"},{"__symbolic":"reference","name":"Array","arguments":[{"__symbolic":"error","message":"Expression form not supported","line":61,"character":25,"module":"./lib/document-search-request"}]}]}],"asHttpBody":[{"__symbolic":"method"}],"asHttpParams":[{"__symbolic":"method"}],"setPage":[{"__symbolic":"method"}],"getSortString":[{"__symbolic":"method"}]}}},"origins":{"DocumentService":"./lib/document.service","DocumentModule":"./lib/document.module","DocumentSearchRequest":"./lib/document-search-request","DocumentSearchRequestHttpBody":"./lib/document-search-request","DocumentSearchRequestImpl":"./lib/document-search-request","ɵa":"./lib/models"},"importAs":"@valtimo/document"}