@salesforce/lds-adapters-platform-files 1.316.0 → 1.318.0

package/dist/es/es2018/types/src/generated/adapters/getFilePreview.d.ts

@@ -0,0 +1,31 @@
+import { AdapterConfigMetadata as $64$luvio_engine_AdapterConfigMetadata, Luvio as $64$luvio_engine_Luvio, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata, Fragment as $64$luvio_engine_Fragment, Snapshot as $64$luvio_engine_Snapshot, FetchResponse as $64$luvio_engine_FetchResponse, ErrorResponse as $64$luvio_engine_ErrorResponse, DispatchResourceRequestContext as $64$luvio_engine_DispatchResourceRequestContext, CoercedAdapterRequestContext as $64$luvio_engine_CoercedAdapterRequestContext, StoreLookup as $64$luvio_engine_StoreLookup, AdapterFactory as $64$luvio_engine_AdapterFactory } from '@luvio/engine';
+import { Untrusted as adapter$45$utils_Untrusted, AdapterValidationConfig as adapter$45$utils_AdapterValidationConfig } from './adapter-utils';
+import { ResourceRequestConfig as resources_getConnectFilesPreviewsByFileIdAndPreviewFormat_ResourceRequestConfig } from '../resources/getConnectFilesPreviewsByFileIdAndPreviewFormat';
+import { FilePreviewRepresentation as types_FilePreviewRepresentation_FilePreviewRepresentation } from '../types/FilePreviewRepresentation';
+export declare const adapterName = "getFilePreview";
+export declare const getFilePreview_ConfigPropertyMetadata: $64$luvio_engine_AdapterConfigMetadata[];
+export declare const getFilePreview_ConfigPropertyNames: adapter$45$utils_AdapterValidationConfig;
+export interface GetFilePreviewConfig {
+    fileId: string;
+    previewFormat: string;
+    endPageNumber?: number;
+    startPageNumber?: number;
+    versionNumber?: number;
+}
+export declare const createResourceParams: (config: GetFilePreviewConfig) => resources_getConnectFilesPreviewsByFileIdAndPreviewFormat_ResourceRequestConfig;
+export declare function keyBuilder(luvio: $64$luvio_engine_Luvio, config: GetFilePreviewConfig): string;
+export declare function keyBuilder_StructuredKey(luvio: $64$luvio_engine_Luvio, config: GetFilePreviewConfig): $64$luvio_engine_NormalizedKeyMetadata;
+export declare function typeCheckConfig(untrustedConfig: adapter$45$utils_Untrusted<GetFilePreviewConfig>): adapter$45$utils_Untrusted<GetFilePreviewConfig>;
+export declare function validateAdapterConfig(untrustedConfig: unknown, configPropertyNames: adapter$45$utils_AdapterValidationConfig): GetFilePreviewConfig | null;
+export declare function adapterFragment(luvio: $64$luvio_engine_Luvio, config: GetFilePreviewConfig): $64$luvio_engine_Fragment;
+export declare function buildCachedSnapshot(luvio: $64$luvio_engine_Luvio, config: GetFilePreviewConfig): $64$luvio_engine_Snapshot<types_FilePreviewRepresentation_FilePreviewRepresentation, any>;
+export declare function onFetchResponseSuccess(luvio: $64$luvio_engine_Luvio, config: GetFilePreviewConfig, resourceParams: resources_getConnectFilesPreviewsByFileIdAndPreviewFormat_ResourceRequestConfig, response: $64$luvio_engine_FetchResponse<types_FilePreviewRepresentation_FilePreviewRepresentation>): Promise<import("@luvio/engine").FulfilledSnapshot<types_FilePreviewRepresentation_FilePreviewRepresentation, {}> | import("@luvio/engine").StaleSnapshot<types_FilePreviewRepresentation_FilePreviewRepresentation, {}> | import("@luvio/engine").PendingSnapshot<types_FilePreviewRepresentation_FilePreviewRepresentation, any>>;
+export declare function onFetchResponseError(luvio: $64$luvio_engine_Luvio, config: GetFilePreviewConfig, resourceParams: resources_getConnectFilesPreviewsByFileIdAndPreviewFormat_ResourceRequestConfig, response: $64$luvio_engine_ErrorResponse): Promise<import("@luvio/engine").ErrorSnapshot>;
+export declare function buildNetworkSnapshot(luvio: $64$luvio_engine_Luvio, config: GetFilePreviewConfig, options?: $64$luvio_engine_DispatchResourceRequestContext): Promise<$64$luvio_engine_Snapshot<types_FilePreviewRepresentation_FilePreviewRepresentation, any>>;
+export type BuildSnapshotContext = {
+    luvio: $64$luvio_engine_Luvio;
+    config: GetFilePreviewConfig;
+};
+export declare function buildNetworkSnapshotCachePolicy(context: BuildSnapshotContext, coercedAdapterRequestContext: $64$luvio_engine_CoercedAdapterRequestContext): Promise<$64$luvio_engine_Snapshot<types_FilePreviewRepresentation_FilePreviewRepresentation, any>>;
+export declare function buildCachedSnapshotCachePolicy(context: BuildSnapshotContext, storeLookup: $64$luvio_engine_StoreLookup<types_FilePreviewRepresentation_FilePreviewRepresentation>): $64$luvio_engine_Snapshot<types_FilePreviewRepresentation_FilePreviewRepresentation, any>;
+export declare const getFilePreviewAdapterFactory: $64$luvio_engine_AdapterFactory<GetFilePreviewConfig, types_FilePreviewRepresentation_FilePreviewRepresentation>;

package/dist/es/es2018/types/src/generated/adapters/getFilePreviewCommunity.d.ts

@@ -0,0 +1,32 @@
+import { AdapterConfigMetadata as $64$luvio_engine_AdapterConfigMetadata, Luvio as $64$luvio_engine_Luvio, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata, Fragment as $64$luvio_engine_Fragment, Snapshot as $64$luvio_engine_Snapshot, FetchResponse as $64$luvio_engine_FetchResponse, ErrorResponse as $64$luvio_engine_ErrorResponse, DispatchResourceRequestContext as $64$luvio_engine_DispatchResourceRequestContext, CoercedAdapterRequestContext as $64$luvio_engine_CoercedAdapterRequestContext, StoreLookup as $64$luvio_engine_StoreLookup, AdapterFactory as $64$luvio_engine_AdapterFactory } from '@luvio/engine';
+import { Untrusted as adapter$45$utils_Untrusted, AdapterValidationConfig as adapter$45$utils_AdapterValidationConfig } from './adapter-utils';
+import { ResourceRequestConfig as resources_getConnectCommunitiesFilesPreviewsByCommunityIdAndFileIdAndPreviewFormat_ResourceRequestConfig } from '../resources/getConnectCommunitiesFilesPreviewsByCommunityIdAndFileIdAndPreviewFormat';
+import { FilePreviewRepresentation as types_FilePreviewRepresentation_FilePreviewRepresentation } from '../types/FilePreviewRepresentation';
+export declare const adapterName = "getFilePreviewCommunity";
+export declare const getFilePreviewCommunity_ConfigPropertyMetadata: $64$luvio_engine_AdapterConfigMetadata[];
+export declare const getFilePreviewCommunity_ConfigPropertyNames: adapter$45$utils_AdapterValidationConfig;
+export interface GetFilePreviewCommunityConfig {
+    communityId: string;
+    fileId: string;
+    previewFormat: string;
+    endPageNumber?: number;
+    startPageNumber?: number;
+    versionNumber?: number;
+}
+export declare const createResourceParams: (config: GetFilePreviewCommunityConfig) => resources_getConnectCommunitiesFilesPreviewsByCommunityIdAndFileIdAndPreviewFormat_ResourceRequestConfig;
+export declare function keyBuilder(luvio: $64$luvio_engine_Luvio, config: GetFilePreviewCommunityConfig): string;
+export declare function keyBuilder_StructuredKey(luvio: $64$luvio_engine_Luvio, config: GetFilePreviewCommunityConfig): $64$luvio_engine_NormalizedKeyMetadata;
+export declare function typeCheckConfig(untrustedConfig: adapter$45$utils_Untrusted<GetFilePreviewCommunityConfig>): adapter$45$utils_Untrusted<GetFilePreviewCommunityConfig>;
+export declare function validateAdapterConfig(untrustedConfig: unknown, configPropertyNames: adapter$45$utils_AdapterValidationConfig): GetFilePreviewCommunityConfig | null;
+export declare function adapterFragment(luvio: $64$luvio_engine_Luvio, config: GetFilePreviewCommunityConfig): $64$luvio_engine_Fragment;
+export declare function buildCachedSnapshot(luvio: $64$luvio_engine_Luvio, config: GetFilePreviewCommunityConfig): $64$luvio_engine_Snapshot<types_FilePreviewRepresentation_FilePreviewRepresentation, any>;
+export declare function onFetchResponseSuccess(luvio: $64$luvio_engine_Luvio, config: GetFilePreviewCommunityConfig, resourceParams: resources_getConnectCommunitiesFilesPreviewsByCommunityIdAndFileIdAndPreviewFormat_ResourceRequestConfig, response: $64$luvio_engine_FetchResponse<types_FilePreviewRepresentation_FilePreviewRepresentation>): Promise<import("@luvio/engine").FulfilledSnapshot<types_FilePreviewRepresentation_FilePreviewRepresentation, {}> | import("@luvio/engine").StaleSnapshot<types_FilePreviewRepresentation_FilePreviewRepresentation, {}> | import("@luvio/engine").PendingSnapshot<types_FilePreviewRepresentation_FilePreviewRepresentation, any>>;
+export declare function onFetchResponseError(luvio: $64$luvio_engine_Luvio, config: GetFilePreviewCommunityConfig, resourceParams: resources_getConnectCommunitiesFilesPreviewsByCommunityIdAndFileIdAndPreviewFormat_ResourceRequestConfig, response: $64$luvio_engine_ErrorResponse): Promise<import("@luvio/engine").ErrorSnapshot>;
+export declare function buildNetworkSnapshot(luvio: $64$luvio_engine_Luvio, config: GetFilePreviewCommunityConfig, options?: $64$luvio_engine_DispatchResourceRequestContext): Promise<$64$luvio_engine_Snapshot<types_FilePreviewRepresentation_FilePreviewRepresentation, any>>;
+export type BuildSnapshotContext = {
+    luvio: $64$luvio_engine_Luvio;
+    config: GetFilePreviewCommunityConfig;
+};
+export declare function buildNetworkSnapshotCachePolicy(context: BuildSnapshotContext, coercedAdapterRequestContext: $64$luvio_engine_CoercedAdapterRequestContext): Promise<$64$luvio_engine_Snapshot<types_FilePreviewRepresentation_FilePreviewRepresentation, any>>;
+export declare function buildCachedSnapshotCachePolicy(context: BuildSnapshotContext, storeLookup: $64$luvio_engine_StoreLookup<types_FilePreviewRepresentation_FilePreviewRepresentation>): $64$luvio_engine_Snapshot<types_FilePreviewRepresentation_FilePreviewRepresentation, any>;
+export declare const getFilePreviewCommunityAdapterFactory: $64$luvio_engine_AdapterFactory<GetFilePreviewCommunityConfig, types_FilePreviewRepresentation_FilePreviewRepresentation>;

package/dist/es/es2018/types/src/generated/artifacts/main.d.ts

@@ -1,2 +1,4 @@
 export { getFileUploadConfigAdapterFactory } from '../adapters/getFileUploadConfig';
 export { createContentDocFromContentBodyAdapterFactory } from '../adapters/createContentDocFromContentBody';
+export { getFilePreviewCommunityAdapterFactory } from '../adapters/getFilePreviewCommunity';
+export { getFilePreviewAdapterFactory } from '../adapters/getFilePreview';

package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts

@@ -1,4 +1,8 @@
 declare let createContentDocFromContentBody: any;
+declare let getFilePreview: any;
+declare let getFilePreviewCommunity: any;
 declare let getFileUploadConfig: any;
+declare let getFilePreview_imperative: any;
+declare let getFilePreviewCommunity_imperative: any;
 declare let getFileUploadConfig_imperative: any;
-export { createContentDocFromContentBody, getFileUploadConfig, getFileUploadConfig_imperative };
+export { createContentDocFromContentBody, getFilePreview, getFilePreviewCommunity, getFileUploadConfig, getFilePreview_imperative, getFilePreviewCommunity_imperative, getFileUploadConfig_imperative, };

package/dist/es/es2018/types/src/generated/resources/getConnectCommunitiesFilesPreviewsByCommunityIdAndFileIdAndPreviewFormat.d.ts

@@ -0,0 +1,22 @@
+import { Luvio as $64$luvio_engine_Luvio, Fragment as $64$luvio_engine_Fragment, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata, FetchResponse as $64$luvio_engine_FetchResponse, SnapshotRefresh as $64$luvio_engine_SnapshotRefresh, FulfilledSnapshot as $64$luvio_engine_FulfilledSnapshot, StaleSnapshot as $64$luvio_engine_StaleSnapshot, PendingSnapshot as $64$luvio_engine_PendingSnapshot, ErrorResponse as $64$luvio_engine_ErrorResponse, ErrorSnapshot as $64$luvio_engine_ErrorSnapshot, ResourceRequest as $64$luvio_engine_ResourceRequest } from '@luvio/engine';
+import { FilePreviewRepresentation as types_FilePreviewRepresentation_FilePreviewRepresentation } from '../types/FilePreviewRepresentation';
+export interface ResourceRequestConfig {
+    urlParams: {
+        communityId: string;
+        fileId: string;
+        previewFormat: string;
+    };
+    queryParams: {
+        endPageNumber?: number;
+        startPageNumber?: number;
+        versionNumber?: number;
+    };
+}
+export declare function select(luvio: $64$luvio_engine_Luvio, params: ResourceRequestConfig): $64$luvio_engine_Fragment;
+export declare function keyBuilder(luvio: $64$luvio_engine_Luvio, params: ResourceRequestConfig): string;
+export declare function keyBuilder_StructuredKey(luvio: $64$luvio_engine_Luvio, params: ResourceRequestConfig): $64$luvio_engine_NormalizedKeyMetadata;
+export declare function getResponseCacheKeys(storeKeyMap: any, luvio: $64$luvio_engine_Luvio, resourceParams: ResourceRequestConfig, response: types_FilePreviewRepresentation_FilePreviewRepresentation): void;
+export declare function ingestSuccess(luvio: $64$luvio_engine_Luvio, resourceParams: ResourceRequestConfig, response: $64$luvio_engine_FetchResponse<types_FilePreviewRepresentation_FilePreviewRepresentation>, snapshotRefresh?: $64$luvio_engine_SnapshotRefresh<types_FilePreviewRepresentation_FilePreviewRepresentation>): $64$luvio_engine_FulfilledSnapshot<types_FilePreviewRepresentation_FilePreviewRepresentation, {}> | $64$luvio_engine_StaleSnapshot<types_FilePreviewRepresentation_FilePreviewRepresentation, {}> | $64$luvio_engine_PendingSnapshot<types_FilePreviewRepresentation_FilePreviewRepresentation, any>;
+export declare function ingestError(luvio: $64$luvio_engine_Luvio, params: ResourceRequestConfig, error: $64$luvio_engine_ErrorResponse, snapshotRefresh?: $64$luvio_engine_SnapshotRefresh<types_FilePreviewRepresentation_FilePreviewRepresentation>): $64$luvio_engine_ErrorSnapshot;
+export declare function createResourceRequest(config: ResourceRequestConfig): $64$luvio_engine_ResourceRequest;
+export default createResourceRequest;

package/dist/es/es2018/types/src/generated/resources/getConnectFilesPreviewsByFileIdAndPreviewFormat.d.ts

@@ -0,0 +1,21 @@
+import { Luvio as $64$luvio_engine_Luvio, Fragment as $64$luvio_engine_Fragment, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata, FetchResponse as $64$luvio_engine_FetchResponse, SnapshotRefresh as $64$luvio_engine_SnapshotRefresh, FulfilledSnapshot as $64$luvio_engine_FulfilledSnapshot, StaleSnapshot as $64$luvio_engine_StaleSnapshot, PendingSnapshot as $64$luvio_engine_PendingSnapshot, ErrorResponse as $64$luvio_engine_ErrorResponse, ErrorSnapshot as $64$luvio_engine_ErrorSnapshot, ResourceRequest as $64$luvio_engine_ResourceRequest } from '@luvio/engine';
+import { FilePreviewRepresentation as types_FilePreviewRepresentation_FilePreviewRepresentation } from '../types/FilePreviewRepresentation';
+export interface ResourceRequestConfig {
+    urlParams: {
+        fileId: string;
+        previewFormat: string;
+    };
+    queryParams: {
+        endPageNumber?: number;
+        startPageNumber?: number;
+        versionNumber?: number;
+    };
+}
+export declare function select(luvio: $64$luvio_engine_Luvio, params: ResourceRequestConfig): $64$luvio_engine_Fragment;
+export declare function keyBuilder(luvio: $64$luvio_engine_Luvio, params: ResourceRequestConfig): string;
+export declare function keyBuilder_StructuredKey(luvio: $64$luvio_engine_Luvio, params: ResourceRequestConfig): $64$luvio_engine_NormalizedKeyMetadata;
+export declare function getResponseCacheKeys(storeKeyMap: any, luvio: $64$luvio_engine_Luvio, resourceParams: ResourceRequestConfig, response: types_FilePreviewRepresentation_FilePreviewRepresentation): void;
+export declare function ingestSuccess(luvio: $64$luvio_engine_Luvio, resourceParams: ResourceRequestConfig, response: $64$luvio_engine_FetchResponse<types_FilePreviewRepresentation_FilePreviewRepresentation>, snapshotRefresh?: $64$luvio_engine_SnapshotRefresh<types_FilePreviewRepresentation_FilePreviewRepresentation>): $64$luvio_engine_FulfilledSnapshot<types_FilePreviewRepresentation_FilePreviewRepresentation, {}> | $64$luvio_engine_StaleSnapshot<types_FilePreviewRepresentation_FilePreviewRepresentation, {}> | $64$luvio_engine_PendingSnapshot<types_FilePreviewRepresentation_FilePreviewRepresentation, any>;
+export declare function ingestError(luvio: $64$luvio_engine_Luvio, params: ResourceRequestConfig, error: $64$luvio_engine_ErrorResponse, snapshotRefresh?: $64$luvio_engine_SnapshotRefresh<types_FilePreviewRepresentation_FilePreviewRepresentation>): $64$luvio_engine_ErrorSnapshot;
+export declare function createResourceRequest(config: ResourceRequestConfig): $64$luvio_engine_ResourceRequest;
+export default createResourceRequest;

package/dist/es/es2018/types/src/generated/types/FilePreviewRepresentation.d.ts

@@ -0,0 +1,42 @@
+import { FilePreviewUrlRepresentation as FilePreviewUrlRepresentation_FilePreviewUrlRepresentation } from './FilePreviewUrlRepresentation';
+import { IngestPath as $64$luvio_engine_IngestPath, Luvio as $64$luvio_engine_Luvio, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
+export declare const TTL = 100;
+export declare const VERSION = "3465c0cb2d3d706149acdcef3dd51708";
+export declare function validate(obj: any, path?: string): TypeError | null;
+export declare const RepresentationType: string;
+export declare function normalize(input: FilePreviewRepresentation, existing: FilePreviewRepresentationNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): FilePreviewRepresentationNormalized;
+export declare const select: () => $64$luvio_engine_FragmentSelection;
+export declare function equals(existing: FilePreviewRepresentationNormalized, incoming: FilePreviewRepresentationNormalized): boolean;
+export declare const ingest: $64$luvio_engine_ResourceIngest;
+export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableStoreKeyMetadataMap, luvio: $64$luvio_engine_Luvio, input: FilePreviewRepresentation, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): void;
+/**
+ * Description of a file preview.
+ *
+ * Keys:
+ *    (none)
+ */
+export interface FilePreviewRepresentationNormalized {
+    /** Represents the format of the preview. */
+    format: string;
+    /** Represents the number of preview items this preview type has. */
+    previewUrlCount: number;
+    /** Represents a URI to retrieve the preview for a specific preview. */
+    previewUrls: Array<FilePreviewUrlRepresentation_FilePreviewUrlRepresentation>;
+    /** Represents the availability status of the preview. */
+    status: string;
+    /** The URL for this representation, which summaries the preview for the specified format. */
+    url: string;
+}
+/**
+ * Description of a file preview.
+ *
+ * Keys:
+ *    (none)
+ */
+export interface FilePreviewRepresentation {
+    format: string;
+    previewUrlCount: number;
+    previewUrls: Array<FilePreviewUrlRepresentation_FilePreviewUrlRepresentation>;
+    status: string;
+    url: string;
+}

package/dist/es/es2018/types/src/generated/types/FilePreviewUrlRepresentation.d.ts

@@ -0,0 +1,31 @@
+import { IngestPath as $64$luvio_engine_IngestPath, Luvio as $64$luvio_engine_Luvio, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
+export declare const VERSION = "991f7d9d5aaae8933546ed0cdf495355";
+export declare function validate(obj: any, path?: string): TypeError | null;
+export declare const RepresentationType: string;
+export declare function normalize(input: FilePreviewUrlRepresentation, existing: FilePreviewUrlRepresentationNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): FilePreviewUrlRepresentationNormalized;
+export declare const select: () => $64$luvio_engine_FragmentSelection;
+export declare function equals(existing: FilePreviewUrlRepresentationNormalized, incoming: FilePreviewUrlRepresentationNormalized): boolean;
+export declare const ingest: $64$luvio_engine_ResourceIngest;
+export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableStoreKeyMetadataMap, luvio: $64$luvio_engine_Luvio, input: FilePreviewUrlRepresentation, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): void;
+/**
+ * Represents the information to retrieve a preview item of a file.
+ *
+ * Keys:
+ *    (none)
+ */
+export interface FilePreviewUrlRepresentationNormalized {
+    /** Preview Page Number (Optional) */
+    pageNumber: number;
+    /** Represents the file preview URL. */
+    previewUrl: string;
+}
+/**
+ * Represents the information to retrieve a preview item of a file.
+ *
+ * Keys:
+ *    (none)
+ */
+export interface FilePreviewUrlRepresentation {
+    pageNumber: number;
+    previewUrl: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-adapters-platform-files",
-    "version": "1.316.0",
+    "version": "1.318.0",
     "description": "A collection of adapters used for Salesforce files, based on chatter-connect-api",
     "license": "SEE LICENSE IN LICENSE.txt",
     "main": "dist/es/es2018/platform-files.js",
@@ -40,10 +40,10 @@
         "test:unit": "jest"
     },
     "dependencies": {
-        "@salesforce/lds-bindings": "^1.316.0"
+        "@salesforce/lds-bindings": "^1.318.0"
     },
     "devDependencies": {
-        "@salesforce/lds-compiler-plugins": "^1.316.0"
+        "@salesforce/lds-compiler-plugins": "^1.318.0"
     },
     "nx": {
         "targets": {