@microsoft/agents-hosting-storage-blob 1.0.0 → 1.0.3-g444d99f704
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -3,7 +3,13 @@ import { TokenCredential } from '@azure/core-auth';
|
|
|
3
3
|
import { AnonymousCredential, StoragePipelineOptions, StorageSharedKeyCredential } from '@azure/storage-blob';
|
|
4
4
|
import { TranscriptStore, PagedResult, TranscriptInfo } from '@microsoft/agents-hosting';
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
6
|
+
* Sanitizes a blob key for use with Azure Blob Storage.
|
|
7
|
+
*
|
|
8
|
+
* @param key - The blob key string to sanitize. Must be non-empty.
|
|
9
|
+
* @param options - Optional configuration options.
|
|
10
|
+
* @param options.decodeTranscriptKey - If true, returns the URL-decoded version of the sanitized key.
|
|
11
|
+
* @returns A sanitized blob key that is safe for use with Azure Blob Storage, truncated to 1024 characters.
|
|
12
|
+
* @throws {Error} When the provided key is null, undefined, or an empty string.
|
|
7
13
|
*
|
|
8
14
|
* @remarks
|
|
9
15
|
* This function performs the following operations:
|
|
@@ -28,25 +34,20 @@ import { TranscriptStore, PagedResult, TranscriptInfo } from '@microsoft/agents-
|
|
|
28
34
|
* // Returns: 'channel1%2Fconversation2%2Factivity.json'
|
|
29
35
|
* ```
|
|
30
36
|
*
|
|
31
|
-
* @param key - The blob key string to sanitize. Must be non-empty.
|
|
32
|
-
* @param options - Optional configuration options.
|
|
33
|
-
* @param options.decodeTranscriptKey - If true, returns the URL-decoded version of the sanitized key.
|
|
34
|
-
* @returns A sanitized blob key that is safe for use with Azure Blob Storage, truncated to 1024 characters.
|
|
35
|
-
*
|
|
36
|
-
* @throws {Error} When the provided key is null, undefined, or an empty string.
|
|
37
37
|
*/
|
|
38
38
|
export declare function sanitizeBlobKey(key: string, options?: BlobsTranscriptStoreOptions): string;
|
|
39
39
|
/**
|
|
40
|
-
*
|
|
41
|
-
* @remarks
|
|
42
|
-
* If a constructor is provided, validates that the value is an instance of that constructor.
|
|
43
|
-
* Otherwise, performs a direct type assertion.
|
|
40
|
+
* Performs type casting with optional constructor validation.
|
|
44
41
|
*
|
|
45
42
|
* @typeParam T - The target type to cast to.
|
|
46
43
|
* @param value - The value to cast.
|
|
47
44
|
* @param ctor - Optional constructor function to validate the value against.
|
|
48
45
|
* @returns The value cast to type T.
|
|
49
46
|
*
|
|
47
|
+
* @remarks
|
|
48
|
+
* If a constructor is provided, validates that the value is an instance of that constructor.
|
|
49
|
+
* Otherwise, performs a direct type assertion.
|
|
50
|
+
*
|
|
50
51
|
* @example
|
|
51
52
|
* ```typescript
|
|
52
53
|
* // With constructor validation
|
|
@@ -82,6 +83,7 @@ export declare class BlobsTranscriptStore implements TranscriptStore {
|
|
|
82
83
|
private _isDecodeTranscriptKey?;
|
|
83
84
|
/**
|
|
84
85
|
* Constructs a new instance of the BlobsTranscriptStore class.
|
|
86
|
+
*
|
|
85
87
|
* @param connectionString - The connection string for the Azure Blob Storage account.
|
|
86
88
|
* @param containerName - The name of the container to use for storing transcripts.
|
|
87
89
|
* @param options - Optional configuration options for the store.
|
|
@@ -92,6 +94,7 @@ export declare class BlobsTranscriptStore implements TranscriptStore {
|
|
|
92
94
|
private _initialize;
|
|
93
95
|
/**
|
|
94
96
|
* Retrieves transcript activities for a specific conversation.
|
|
97
|
+
*
|
|
95
98
|
* @param channelId - The ID of the channel.
|
|
96
99
|
* @param conversationId - The ID of the conversation.
|
|
97
100
|
* @param continuationToken - Optional token for paginated results.
|
|
@@ -101,6 +104,7 @@ export declare class BlobsTranscriptStore implements TranscriptStore {
|
|
|
101
104
|
getTranscriptActivities(channelId: string, conversationId: string, continuationToken?: string, startDate?: Date): Promise<PagedResult<Activity>>;
|
|
102
105
|
/**
|
|
103
106
|
* Lists all transcripts for a specific channel.
|
|
107
|
+
*
|
|
104
108
|
* @param channelId - The ID of the channel.
|
|
105
109
|
* @param continuationToken - Optional token for paginated results.
|
|
106
110
|
* @returns A promise resolving to a paged result of transcript information.
|
|
@@ -108,6 +112,7 @@ export declare class BlobsTranscriptStore implements TranscriptStore {
|
|
|
108
112
|
listTranscripts(channelId: string, continuationToken?: string): Promise<PagedResult<TranscriptInfo>>;
|
|
109
113
|
/**
|
|
110
114
|
* Deletes all transcripts for a specific conversation.
|
|
115
|
+
*
|
|
111
116
|
* @param channelId - The ID of the channel.
|
|
112
117
|
* @param conversationId - The ID of the conversation.
|
|
113
118
|
* @returns A promise that resolves when the deletion is complete.
|
|
@@ -115,6 +120,7 @@ export declare class BlobsTranscriptStore implements TranscriptStore {
|
|
|
115
120
|
deleteTranscript(channelId: string, conversationId: string): Promise<void>;
|
|
116
121
|
/**
|
|
117
122
|
* Logs an activity to the transcript store.
|
|
123
|
+
*
|
|
118
124
|
* @param activity - The activity to log.
|
|
119
125
|
* @param options - Optional configuration options for the operation.
|
|
120
126
|
* @returns A promise that resolves when the activity is logged.
|
|
@@ -55,7 +55,7 @@ function formatTicks(timestamp) {
|
|
|
55
55
|
return ticks.toString(16);
|
|
56
56
|
}
|
|
57
57
|
/**
|
|
58
|
-
*
|
|
58
|
+
* Generates a sanitized prefix for a channel.
|
|
59
59
|
* @param channelId - The ID of the channel.
|
|
60
60
|
* @returns A sanitized string prefix for the channel.
|
|
61
61
|
*/
|
|
@@ -83,7 +83,13 @@ function getBlobKey(activity, options) {
|
|
|
83
83
|
return sanitizeBlobKey([activity.channelId, (_a = activity.conversation) === null || _a === void 0 ? void 0 : _a.id, `${formatTicks(timestamp)}-${activity.id}.json`].join('/'), options);
|
|
84
84
|
}
|
|
85
85
|
/**
|
|
86
|
-
*
|
|
86
|
+
* Sanitizes a blob key for use with Azure Blob Storage.
|
|
87
|
+
*
|
|
88
|
+
* @param key - The blob key string to sanitize. Must be non-empty.
|
|
89
|
+
* @param options - Optional configuration options.
|
|
90
|
+
* @param options.decodeTranscriptKey - If true, returns the URL-decoded version of the sanitized key.
|
|
91
|
+
* @returns A sanitized blob key that is safe for use with Azure Blob Storage, truncated to 1024 characters.
|
|
92
|
+
* @throws {Error} When the provided key is null, undefined, or an empty string.
|
|
87
93
|
*
|
|
88
94
|
* @remarks
|
|
89
95
|
* This function performs the following operations:
|
|
@@ -108,12 +114,6 @@ function getBlobKey(activity, options) {
|
|
|
108
114
|
* // Returns: 'channel1%2Fconversation2%2Factivity.json'
|
|
109
115
|
* ```
|
|
110
116
|
*
|
|
111
|
-
* @param key - The blob key string to sanitize. Must be non-empty.
|
|
112
|
-
* @param options - Optional configuration options.
|
|
113
|
-
* @param options.decodeTranscriptKey - If true, returns the URL-decoded version of the sanitized key.
|
|
114
|
-
* @returns A sanitized blob key that is safe for use with Azure Blob Storage, truncated to 1024 characters.
|
|
115
|
-
*
|
|
116
|
-
* @throws {Error} When the provided key is null, undefined, or an empty string.
|
|
117
117
|
*/
|
|
118
118
|
function sanitizeBlobKey(key, options) {
|
|
119
119
|
if (!key || key.length === 0) {
|
|
@@ -129,16 +129,17 @@ function sanitizeBlobKey(key, options) {
|
|
|
129
129
|
return encodedKey;
|
|
130
130
|
}
|
|
131
131
|
/**
|
|
132
|
-
*
|
|
133
|
-
* @remarks
|
|
134
|
-
* If a constructor is provided, validates that the value is an instance of that constructor.
|
|
135
|
-
* Otherwise, performs a direct type assertion.
|
|
132
|
+
* Performs type casting with optional constructor validation.
|
|
136
133
|
*
|
|
137
134
|
* @typeParam T - The target type to cast to.
|
|
138
135
|
* @param value - The value to cast.
|
|
139
136
|
* @param ctor - Optional constructor function to validate the value against.
|
|
140
137
|
* @returns The value cast to type T.
|
|
141
138
|
*
|
|
139
|
+
* @remarks
|
|
140
|
+
* If a constructor is provided, validates that the value is an instance of that constructor.
|
|
141
|
+
* Otherwise, performs a direct type assertion.
|
|
142
|
+
*
|
|
142
143
|
* @example
|
|
143
144
|
* ```typescript
|
|
144
145
|
* // With constructor validation
|
|
@@ -161,6 +162,7 @@ const MAX_PAGE_SIZE = 20;
|
|
|
161
162
|
class BlobsTranscriptStore {
|
|
162
163
|
/**
|
|
163
164
|
* Constructs a new instance of the BlobsTranscriptStore class.
|
|
165
|
+
*
|
|
164
166
|
* @param connectionString - The connection string for the Azure Blob Storage account.
|
|
165
167
|
* @param containerName - The name of the container to use for storing transcripts.
|
|
166
168
|
* @param options - Optional configuration options for the store.
|
|
@@ -199,6 +201,7 @@ class BlobsTranscriptStore {
|
|
|
199
201
|
}
|
|
200
202
|
/**
|
|
201
203
|
* Retrieves transcript activities for a specific conversation.
|
|
204
|
+
*
|
|
202
205
|
* @param channelId - The ID of the channel.
|
|
203
206
|
* @param conversationId - The ID of the conversation.
|
|
204
207
|
* @param continuationToken - Optional token for paginated results.
|
|
@@ -252,6 +255,7 @@ class BlobsTranscriptStore {
|
|
|
252
255
|
}
|
|
253
256
|
/**
|
|
254
257
|
* Lists all transcripts for a specific channel.
|
|
258
|
+
*
|
|
255
259
|
* @param channelId - The ID of the channel.
|
|
256
260
|
* @param continuationToken - Optional token for paginated results.
|
|
257
261
|
* @returns A promise resolving to a paged result of transcript information.
|
|
@@ -290,6 +294,7 @@ class BlobsTranscriptStore {
|
|
|
290
294
|
}
|
|
291
295
|
/**
|
|
292
296
|
* Deletes all transcripts for a specific conversation.
|
|
297
|
+
*
|
|
293
298
|
* @param channelId - The ID of the channel.
|
|
294
299
|
* @param conversationId - The ID of the conversation.
|
|
295
300
|
* @returns A promise that resolves when the deletion is complete.
|
|
@@ -316,6 +321,7 @@ class BlobsTranscriptStore {
|
|
|
316
321
|
}
|
|
317
322
|
/**
|
|
318
323
|
* Logs an activity to the transcript store.
|
|
324
|
+
*
|
|
319
325
|
* @param activity - The activity to log.
|
|
320
326
|
* @param options - Optional configuration options for the operation.
|
|
321
327
|
* @returns A promise that resolves when the activity is logged.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"blobsTranscriptStore.js","sourceRoot":"","sources":["../../src/blobsTranscriptStore.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6FA,0CAeC;
|
|
1
|
+
{"version":3,"file":"blobsTranscriptStore.js","sourceRoot":"","sources":["../../src/blobsTranscriptStore.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6FA,0CAeC;AAuBD,8BAMC;AAzID,uCAAwB;AACxB,iEAA8C;AAC9C,gEAAqD;AAErD,sDAO4B;AAG5B;;;;GAIG;AACH,SAAS,WAAW,CAAE,SAAe;IACnC,MAAM,UAAU,GAAG,kBAAkB,CAAA;IACrC,MAAM,mBAAmB,GAAG,KAAK,CAAA;IACjC,MAAM,KAAK,GAAG,UAAU,GAAG,SAAS,CAAC,OAAO,EAAE,GAAG,mBAAmB,CAAA;IACpE,OAAO,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;AAC3B,CAAC;AAED;;;;GAIG;AACH,SAAS,gBAAgB,CAAE,SAAiB;IAC1C,OAAO,eAAe,CAAC,GAAG,SAAS,GAAG,CAAC,CAAA;AACzC,CAAC;AAED;;;;;GAKG;AACH,SAAS,qBAAqB,CAAE,SAAiB,EAAE,cAAsB;IACvE,OAAO,eAAe,CAAC,GAAG,SAAS,IAAI,cAAc,EAAE,CAAC,CAAA;AAC1D,CAAC;AAED,SAAS,UAAU,CAAE,QAAkB,EAAE,OAAqC;;IAC5E,IAAI,CAAC,CAAC,QAAQ,CAAC,SAAS,YAAY,IAAI,CAAC,EAAE,CAAC;QAC1C,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAA;IACnE,CAAC;IAED,MAAM,EAAE,SAAS,EAAE,GAAG,CAAC;SACpB,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;SACzC,WAAW,EAAE;SACb,KAAK,CAAC,QAAQ,CAAC,CAAA;IAClB,OAAO,eAAe,CACpB,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAA,QAAQ,CAAC,YAAY,0CAAE,EAAE,EAAE,GAAG,WAAW,CAAC,SAAS,CAAC,IAAI,QAAQ,CAAC,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAC1G,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,SAAgB,eAAe,CAAE,GAAW,EAAE,OAAqC;IACjF,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAA;IACnD,CAAC;IAED,MAAM,SAAS,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE;QACzD,OAAO,IAAI,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,CAAA;IACtC,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,CAAA;IAEtB,MAAM,UAAU,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,CAAA;IAEhE,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,mBAAmB,EAAE,CAAC;QACjC,OAAO,kBAAkB,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,CAAA;IACvD,CAAC;IACD,OAAO,UAAU,CAAA;AACnB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAgB,SAAS,CAAK,KAAc,EAAE,IAAkC;IAC9E,IAAI,IAAI,IAAI,IAAI,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;QAC1C,OAAO,KAAK,CAAA;IACd,CAAC;IAED,OAAO,KAAU,CAAA;AACnB,CAAC;AAED,MAAM,aAAa,GAAG,EAAE,CAAA;AAiBxB;;GAEG;AACH,MAAa,oBAAoB;IAM/B;;;;;;;;OAQG;IACH,YACE,gBAAwB,EACxB,aAAqB,EACrB,OAAqC,EACrC,cAAc,GAAG,EAAE,EACnB,eAAoF;QAlBrE,iBAAY,GAAG,QAAQ,CAAA;QAEhC,2BAAsB,GAAa,KAAK,CAAA;QAkB9C,IAAI,cAAc,KAAK,EAAE,IAAI,eAAe,KAAK,IAAI,EAAE,CAAC;YACtD,CAAC,CAAC,MAAM,CAAC,EAAE,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC;gBAC7C,cAAc;aACf,CAAC,CAAA;YAEF,IAAI,CAAC,gBAAgB,GAAG,IAAI,8BAAe,CACzC,cAAc,EACd,eAAe,EACf,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,sBAAsB,CAChC,CAAA;YAED,IAAI,cAAc,CAAC,IAAI,EAAE,KAAK,6BAA6B,EAAE,CAAC;gBAC5D,IAAI,CAAC,YAAY,GAAG,CAAC,CAAA;YACvB,CAAC;QACH,CAAC;aAAM,CAAC;YACN,CAAC,CAAC,MAAM,CAAC,EAAE,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC;gBAC1E,gBAAgB;gBAChB,aAAa;aACd,CAAC,CAAA;YAEF,IAAI,CAAC,gBAAgB,GAAG,IAAI,8BAAe,CACzC,gBAAgB,EAChB,aAAa,EACb,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,sBAAsB,CAChC,CAAA;YAED,IAAI,gBAAgB,CAAC,IAAI,EAAE,KAAK,6BAA6B,EAAE,CAAC;gBAC9D,IAAI,CAAC,YAAY,GAAG,CAAC,CAAA;YACvB,CAAC;QACH,CAAC;QAED,IAAI,CAAC,sBAAsB,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,mBAAmB,CAAA;IAC5D,CAAC;IAEO,WAAW;QACjB,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC7B,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,CAAA;QACrE,CAAC;QACD,OAAO,IAAI,CAAC,kBAAkB,CAAA;IAChC,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,uBAAuB,CAC3B,SAAiB,EACjB,cAAsB,EACtB,iBAA0B,EAC1B,SAAgB;;QAEhB,CAAC,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,cAAc,EAAE,CAAC,CAAA;QAEpG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAA;QAExB,MAAM,MAAM,GAAG,qBAAqB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAA;QAC/D,OAAO,CAAC,GAAG,CAAC,iBAAiB,MAAM,EAAE,CAAC,CAAA;QAEtC,MAAM,IAAI,GAAG,IAAI,CAAC,gBAAgB;aAC/B,oBAAoB,CAAC,GAAG,EAAE;YACzB,MAAM;SACP,CAAC;aACD,MAAM,CAAC,EAAE,iBAAiB,EAAE,WAAW,EAAE,aAAa,EAAE,CAAC,CAAA;QAE5D,IAAI,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAA;QAC5B,MAAM,MAAM,GAAe,EAAE,CAAA;QAC7B,IAAI,QAA+D,CAAA;QACnE,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,QAAQ,GAAG,SAAS,CAA4C,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,mCAAI,EAAE,CAAC,CAAA;YAClF,MAAM,SAAS,GAAG,MAAA,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO,0CAAE,SAAS,mCAAI,EAAE,CAAA;YAEpD,OAAO,CAAC,GAAG,CAAC,WAAW,SAAS,CAAC,MAAM,cAAc,CAAC,CAAA;YAEtD,MAAM,OAAO,GACH,SAAS,IAAI,IAAI;gBACf,CAAC,CAAC,SAAS,CAAC,SAAS,CACnB,CAAC,QAAkB,EAAE,EAAE,eAAC,OAAA,CAAA,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,UAAU,0CAAE,SAAS,KAAI,CAAA,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,UAAU,0CAAE,SAAS,KAAI,SAAS,CAAA,EAAA,CACxG;gBACD,CAAC,CAAC,CAAC,CAAA;YAEf,OAAO,CAAC,GAAG,CAAC,YAAY,OAAO,EAAE,CAAC,CAAA;YAElC,IAAI,OAAO,KAAK,CAAC,CAAC,EAAE,CAAC;gBACnB,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,GAAG,CAClC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,QAAkB,EAAE,EAAE;oBACxD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAA;oBAEhF,MAAM,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAA;oBACnC,IAAI,CAAC,kBAAkB,EAAE,CAAC;wBACxB,OAAO,IAAI,CAAA;oBACb,CAAC;oBAED,MAAM,QAAQ,GAAG,CAAC,MAAM,mBAAe,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAQ,CAAA;oBACxE,OAAO,0BAAQ,CAAC,UAAU,CAAC,EAAE,GAAG,QAAQ,EAAE,SAAS,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,CAAA;gBACtF,CAAC,CAAC,CACH,CAAA;gBAED,UAAU,CAAC,OAAO,CAAC,CAAC,QAAyB,EAAE,EAAE;oBAC/C,IAAI,QAAQ;wBAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;gBACrC,CAAC,CAAC,CAAA;YACJ,CAAC;YAED,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAA;QAC1B,CAAC;QAED,OAAO,CAAC,GAAG,CAAC,6BAA6B,MAAM,CAAC,MAAM,EAAE,CAAC,CAAA;QAEzD,OAAO;YACL,iBAAiB,EAAE,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,iBAAiB,mCAAI,EAAE;YACpD,KAAK,EAAE,MAAM,CAAC,MAAM,CAAa,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;SACjG,CAAA;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,eAAe,CAAE,SAAiB,EAAE,iBAA0B;;QAClE,CAAC,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,CAAC,CAAA;QAExD,MAAM,IAAI,CAAC,WAAW,EAAE,CAAA;QAExB,MAAM,IAAI,GAAG,IAAI,CAAC,gBAAgB;aAC/B,oBAAoB,CAAC,GAAG,EAAE;YACzB,MAAM,EAAE,gBAAgB,CAAC,SAAS,CAAC;SACpC,CAAC;aACD,MAAM,CAAC,EAAE,iBAAiB,EAAE,WAAW,EAAE,aAAa,EAAE,CAAC,CAAA;QAE5D,IAAI,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAA;QAC5B,MAAM,MAAM,GAAU,EAAE,CAAA;QACxB,IAAI,QAA+D,CAAA;QAEnE,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,MAAM,QAAQ,GAAG,SAAS,CAA4C,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,mCAAI,EAAE,CAAC,CAAA;YACxF,MAAM,SAAS,GAAG,MAAA,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO,0CAAE,SAAS,mCAAI,EAAE,CAAA;YAEpD,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;;gBACvC,MAAM,CAAC,EAAE,EAAE,CAAC,GAAG,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;gBAE3D,MAAM,OAAO,GAAG,CAAA,MAAA,QAAQ,CAAC,QAAQ,0CAAE,SAAS,EAAC,CAAC,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAA;gBAEjG,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,EAAE,CAAA;YACnC,CAAC,CAAC,CAAA;YAEF,KAAK,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;gBAC3B,IAAI,UAAU;oBAAE,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;YACzC,CAAC,CAAC,CAAA;YAEF,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAA;QAC1B,CAAC;QAED,OAAO;YACL,iBAAiB,EAAE,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,iBAAiB,mCAAI,EAAE;YACpD,KAAK,EAAE,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE;SACpB,CAAA;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,gBAAgB,CAAE,SAAiB,EAAE,cAAsB;;QAC/D,CAAC,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,cAAc,EAAE,CAAC,CAAA;QAEpG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAA;QAExB,MAAM,IAAI,GAAG,IAAI,CAAC,gBAAgB;aAC/B,oBAAoB,CAAC,GAAG,EAAE;YACzB,MAAM,EAAE,qBAAqB,CAAC,SAAS,EAAE,cAAc,CAAC;SACzD,CAAC;aACD,MAAM,CAAC;YACN,WAAW,EAAE,aAAa;SAC3B,CAAC,CAAA;QAEJ,IAAI,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAA;QAC5B,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,MAAM,QAAQ,GAAG,SAAS,CAA4C,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,mCAAI,EAAE,CAAC,CAAA;YACxF,MAAM,SAAS,GAAG,MAAA,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO,0CAAE,SAAS,mCAAI,EAAE,CAAA;YAEpD,MAAM,gBAAgB,GAAG,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAChD,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAChD,CAAA;YAED,MAAM,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAA;YAEnC,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAA;QAC1B,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,WAAW,CAAE,QAAkB,EAAE,OAAqC;;QAC1E,CAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAA;QAEjE,IAAI,CAAC,CAAC,QAAQ,CAAC,SAAS,YAAY,IAAI,CAAC,EAAE,CAAC;YAC1C,QAAQ,CAAC,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAA;QACrF,CAAC;QAED,MAAM,IAAI,CAAC,WAAW,EAAE,CAAA;QAExB,MAAM,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,UAAU,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAA;QACpF,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAA;QAC3C,MAAM,QAAQ,GAA2B;YACvC,MAAM,EAAE,MAAA,MAAA,QAAQ,CAAC,IAAI,0CAAE,EAAE,mCAAI,EAAE;YAC/B,WAAW,EAAE,MAAA,MAAA,QAAQ,CAAC,SAAS,0CAAE,EAAE,mCAAI,EAAE;SAC1C,CAAA;QAED,IAAI,QAAQ,CAAC,EAAE,EAAE,CAAC;YAChB,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,EAAE,CAAA;QAC3B,CAAC;QACD,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;YACvB,QAAQ,CAAC,SAAS,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,CAAA;QAC5D,CAAC;QAED,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,UAAU,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAA;IAChE,CAAC;CACF;AA9PD,oDA8PC"}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json.schemastore.org/package.json",
|
|
3
3
|
"name": "@microsoft/agents-hosting-storage-blob",
|
|
4
|
-
"version": "1.0.
|
|
4
|
+
"version": "1.0.3-g444d99f704",
|
|
5
5
|
"homepage": "https://github.com/microsoft/Agents-for-js",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"types": "dist/src/index.d.ts",
|
|
18
18
|
"dependencies": {
|
|
19
19
|
"@azure/storage-blob": "^12.27.0",
|
|
20
|
-
"@microsoft/agents-hosting": "1.0.
|
|
20
|
+
"@microsoft/agents-hosting": "1.0.3-g444d99f704"
|
|
21
21
|
},
|
|
22
22
|
"license": "MIT",
|
|
23
23
|
"files": [
|
|
@@ -25,7 +25,7 @@ function formatTicks (timestamp: Date): string {
|
|
|
25
25
|
}
|
|
26
26
|
|
|
27
27
|
/**
|
|
28
|
-
*
|
|
28
|
+
* Generates a sanitized prefix for a channel.
|
|
29
29
|
* @param channelId - The ID of the channel.
|
|
30
30
|
* @returns A sanitized string prefix for the channel.
|
|
31
31
|
*/
|
|
@@ -59,7 +59,13 @@ function getBlobKey (activity: Activity, options?: BlobsTranscriptStoreOptions):
|
|
|
59
59
|
}
|
|
60
60
|
|
|
61
61
|
/**
|
|
62
|
-
*
|
|
62
|
+
* Sanitizes a blob key for use with Azure Blob Storage.
|
|
63
|
+
*
|
|
64
|
+
* @param key - The blob key string to sanitize. Must be non-empty.
|
|
65
|
+
* @param options - Optional configuration options.
|
|
66
|
+
* @param options.decodeTranscriptKey - If true, returns the URL-decoded version of the sanitized key.
|
|
67
|
+
* @returns A sanitized blob key that is safe for use with Azure Blob Storage, truncated to 1024 characters.
|
|
68
|
+
* @throws {Error} When the provided key is null, undefined, or an empty string.
|
|
63
69
|
*
|
|
64
70
|
* @remarks
|
|
65
71
|
* This function performs the following operations:
|
|
@@ -84,12 +90,6 @@ function getBlobKey (activity: Activity, options?: BlobsTranscriptStoreOptions):
|
|
|
84
90
|
* // Returns: 'channel1%2Fconversation2%2Factivity.json'
|
|
85
91
|
* ```
|
|
86
92
|
*
|
|
87
|
-
* @param key - The blob key string to sanitize. Must be non-empty.
|
|
88
|
-
* @param options - Optional configuration options.
|
|
89
|
-
* @param options.decodeTranscriptKey - If true, returns the URL-decoded version of the sanitized key.
|
|
90
|
-
* @returns A sanitized blob key that is safe for use with Azure Blob Storage, truncated to 1024 characters.
|
|
91
|
-
*
|
|
92
|
-
* @throws {Error} When the provided key is null, undefined, or an empty string.
|
|
93
93
|
*/
|
|
94
94
|
export function sanitizeBlobKey (key: string, options?: BlobsTranscriptStoreOptions): string {
|
|
95
95
|
if (!key || key.length === 0) {
|
|
@@ -109,16 +109,17 @@ export function sanitizeBlobKey (key: string, options?: BlobsTranscriptStoreOpti
|
|
|
109
109
|
}
|
|
110
110
|
|
|
111
111
|
/**
|
|
112
|
-
*
|
|
113
|
-
* @remarks
|
|
114
|
-
* If a constructor is provided, validates that the value is an instance of that constructor.
|
|
115
|
-
* Otherwise, performs a direct type assertion.
|
|
112
|
+
* Performs type casting with optional constructor validation.
|
|
116
113
|
*
|
|
117
114
|
* @typeParam T - The target type to cast to.
|
|
118
115
|
* @param value - The value to cast.
|
|
119
116
|
* @param ctor - Optional constructor function to validate the value against.
|
|
120
117
|
* @returns The value cast to type T.
|
|
121
118
|
*
|
|
119
|
+
* @remarks
|
|
120
|
+
* If a constructor is provided, validates that the value is an instance of that constructor.
|
|
121
|
+
* Otherwise, performs a direct type assertion.
|
|
122
|
+
*
|
|
122
123
|
* @example
|
|
123
124
|
* ```typescript
|
|
124
125
|
* // With constructor validation
|
|
@@ -164,6 +165,7 @@ export class BlobsTranscriptStore implements TranscriptStore {
|
|
|
164
165
|
|
|
165
166
|
/**
|
|
166
167
|
* Constructs a new instance of the BlobsTranscriptStore class.
|
|
168
|
+
*
|
|
167
169
|
* @param connectionString - The connection string for the Azure Blob Storage account.
|
|
168
170
|
* @param containerName - The name of the container to use for storing transcripts.
|
|
169
171
|
* @param options - Optional configuration options for the store.
|
|
@@ -220,6 +222,7 @@ export class BlobsTranscriptStore implements TranscriptStore {
|
|
|
220
222
|
|
|
221
223
|
/**
|
|
222
224
|
* Retrieves transcript activities for a specific conversation.
|
|
225
|
+
*
|
|
223
226
|
* @param channelId - The ID of the channel.
|
|
224
227
|
* @param conversationId - The ID of the conversation.
|
|
225
228
|
* @param continuationToken - Optional token for paginated results.
|
|
@@ -296,6 +299,7 @@ export class BlobsTranscriptStore implements TranscriptStore {
|
|
|
296
299
|
|
|
297
300
|
/**
|
|
298
301
|
* Lists all transcripts for a specific channel.
|
|
302
|
+
*
|
|
299
303
|
* @param channelId - The ID of the channel.
|
|
300
304
|
* @param continuationToken - Optional token for paginated results.
|
|
301
305
|
* @returns A promise resolving to a paged result of transcript information.
|
|
@@ -342,6 +346,7 @@ export class BlobsTranscriptStore implements TranscriptStore {
|
|
|
342
346
|
|
|
343
347
|
/**
|
|
344
348
|
* Deletes all transcripts for a specific conversation.
|
|
349
|
+
*
|
|
345
350
|
* @param channelId - The ID of the channel.
|
|
346
351
|
* @param conversationId - The ID of the conversation.
|
|
347
352
|
* @returns A promise that resolves when the deletion is complete.
|
|
@@ -376,6 +381,7 @@ export class BlobsTranscriptStore implements TranscriptStore {
|
|
|
376
381
|
|
|
377
382
|
/**
|
|
378
383
|
* Logs an activity to the transcript store.
|
|
384
|
+
*
|
|
379
385
|
* @param activity - The activity to log.
|
|
380
386
|
* @param options - Optional configuration options for the operation.
|
|
381
387
|
* @returns A promise that resolves when the activity is logged.
|