@microsoft/agents-hosting-storage-blob 0.2.14 → 0.3.5
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.
|
@@ -9,7 +9,13 @@ export declare function maybeCast<T>(value: unknown, ctor?: {
|
|
|
9
9
|
* Options for configuring the BlobsTranscriptStore.
|
|
10
10
|
*/
|
|
11
11
|
export interface BlobsTranscriptStoreOptions {
|
|
12
|
+
/**
|
|
13
|
+
* Optional pipeline options for configuring the Azure Blob Storage client.
|
|
14
|
+
*/
|
|
12
15
|
storagePipelineOptions?: StoragePipelineOptions;
|
|
16
|
+
/**
|
|
17
|
+
* Indicates whether to decode the transcript key when retrieving transcripts.
|
|
18
|
+
*/
|
|
13
19
|
decodeTranscriptKey?: boolean;
|
|
14
20
|
}
|
|
15
21
|
/**
|
|
@@ -20,10 +26,44 @@ export declare class BlobsTranscriptStore implements TranscriptStore {
|
|
|
20
26
|
private readonly _concurrency;
|
|
21
27
|
private _initializePromise?;
|
|
22
28
|
private _isDecodeTranscriptKey?;
|
|
29
|
+
/**
|
|
30
|
+
* Constructs a new instance of the BlobsTranscriptStore class.
|
|
31
|
+
* @param connectionString - The connection string for the Azure Blob Storage account.
|
|
32
|
+
* @param containerName - The name of the container to use for storing transcripts.
|
|
33
|
+
* @param options - Optional configuration options for the store.
|
|
34
|
+
* @param blobServiceUri - Optional URI for the blob service.
|
|
35
|
+
* @param tokenCredential - Optional credentials for authenticating with the blob service.
|
|
36
|
+
*/
|
|
23
37
|
constructor(connectionString: string, containerName: string, options?: BlobsTranscriptStoreOptions, blobServiceUri?: string, tokenCredential?: StorageSharedKeyCredential | AnonymousCredential);
|
|
24
38
|
private _initialize;
|
|
39
|
+
/**
|
|
40
|
+
* Retrieves transcript activities for a specific conversation.
|
|
41
|
+
* @param channelId - The ID of the channel.
|
|
42
|
+
* @param conversationId - The ID of the conversation.
|
|
43
|
+
* @param continuationToken - Optional token for paginated results.
|
|
44
|
+
* @param startDate - Optional start date to filter activities.
|
|
45
|
+
* @returns A promise resolving to a paged result of activities.
|
|
46
|
+
*/
|
|
25
47
|
getTranscriptActivities(channelId: string, conversationId: string, continuationToken?: string, startDate?: Date): Promise<PagedResult<Activity>>;
|
|
48
|
+
/**
|
|
49
|
+
* Lists all transcripts for a specific channel.
|
|
50
|
+
* @param channelId - The ID of the channel.
|
|
51
|
+
* @param continuationToken - Optional token for paginated results.
|
|
52
|
+
* @returns A promise resolving to a paged result of transcript information.
|
|
53
|
+
*/
|
|
26
54
|
listTranscripts(channelId: string, continuationToken?: string): Promise<PagedResult<TranscriptInfo>>;
|
|
55
|
+
/**
|
|
56
|
+
* Deletes all transcripts for a specific conversation.
|
|
57
|
+
* @param channelId - The ID of the channel.
|
|
58
|
+
* @param conversationId - The ID of the conversation.
|
|
59
|
+
* @returns A promise that resolves when the deletion is complete.
|
|
60
|
+
*/
|
|
27
61
|
deleteTranscript(channelId: string, conversationId: string): Promise<void>;
|
|
62
|
+
/**
|
|
63
|
+
* Logs an activity to the transcript store.
|
|
64
|
+
* @param activity - The activity to log.
|
|
65
|
+
* @param options - Optional configuration options for the operation.
|
|
66
|
+
* @returns A promise that resolves when the activity is logged.
|
|
67
|
+
*/
|
|
28
68
|
logActivity(activity: Activity, options?: BlobsTranscriptStoreOptions): Promise<void>;
|
|
29
69
|
}
|
|
@@ -42,15 +42,31 @@ exports.maybeCast = maybeCast;
|
|
|
42
42
|
const z = __importStar(require("zod"));
|
|
43
43
|
const consumers_1 = __importDefault(require("stream/consumers"));
|
|
44
44
|
const storage_blob_1 = require("@azure/storage-blob");
|
|
45
|
+
/**
|
|
46
|
+
* Formats a Date object into a hexadecimal string representing ticks.
|
|
47
|
+
* @param timestamp - The Date object to format.
|
|
48
|
+
* @returns A string representing the formatted ticks.
|
|
49
|
+
*/
|
|
45
50
|
function formatTicks(timestamp) {
|
|
46
51
|
const epochTicks = 621355968000000000;
|
|
47
52
|
const ticksPerMillisecond = 10000;
|
|
48
53
|
const ticks = epochTicks + timestamp.getTime() * ticksPerMillisecond;
|
|
49
54
|
return ticks.toString(16);
|
|
50
55
|
}
|
|
56
|
+
/**
|
|
57
|
+
* Generates a sanitized prefix for a channel.
|
|
58
|
+
* @param channelId - The ID of the channel.
|
|
59
|
+
* @returns A sanitized string prefix for the channel.
|
|
60
|
+
*/
|
|
51
61
|
function getChannelPrefix(channelId) {
|
|
52
62
|
return sanitizeBlobKey(`${channelId}/`);
|
|
53
63
|
}
|
|
64
|
+
/**
|
|
65
|
+
* Generates a sanitized prefix for a conversation within a channel.
|
|
66
|
+
* @param channelId - The ID of the channel.
|
|
67
|
+
* @param conversationId - The ID of the conversation.
|
|
68
|
+
* @returns A sanitized string prefix for the conversation.
|
|
69
|
+
*/
|
|
54
70
|
function getConversationPrefix(channelId, conversationId) {
|
|
55
71
|
return sanitizeBlobKey(`${channelId}/${conversationId}`);
|
|
56
72
|
}
|
|
@@ -89,6 +105,14 @@ const MAX_PAGE_SIZE = 20;
|
|
|
89
105
|
* A class that implements the TranscriptStore interface using Azure Blob Storage.
|
|
90
106
|
*/
|
|
91
107
|
class BlobsTranscriptStore {
|
|
108
|
+
/**
|
|
109
|
+
* Constructs a new instance of the BlobsTranscriptStore class.
|
|
110
|
+
* @param connectionString - The connection string for the Azure Blob Storage account.
|
|
111
|
+
* @param containerName - The name of the container to use for storing transcripts.
|
|
112
|
+
* @param options - Optional configuration options for the store.
|
|
113
|
+
* @param blobServiceUri - Optional URI for the blob service.
|
|
114
|
+
* @param tokenCredential - Optional credentials for authenticating with the blob service.
|
|
115
|
+
*/
|
|
92
116
|
constructor(connectionString, containerName, options, blobServiceUri = '', tokenCredential) {
|
|
93
117
|
this._concurrency = Infinity;
|
|
94
118
|
this._isDecodeTranscriptKey = false;
|
|
@@ -119,6 +143,14 @@ class BlobsTranscriptStore {
|
|
|
119
143
|
}
|
|
120
144
|
return this._initializePromise;
|
|
121
145
|
}
|
|
146
|
+
/**
|
|
147
|
+
* Retrieves transcript activities for a specific conversation.
|
|
148
|
+
* @param channelId - The ID of the channel.
|
|
149
|
+
* @param conversationId - The ID of the conversation.
|
|
150
|
+
* @param continuationToken - Optional token for paginated results.
|
|
151
|
+
* @param startDate - Optional start date to filter activities.
|
|
152
|
+
* @returns A promise resolving to a paged result of activities.
|
|
153
|
+
*/
|
|
122
154
|
async getTranscriptActivities(channelId, conversationId, continuationToken, startDate) {
|
|
123
155
|
var _a, _b, _c, _d;
|
|
124
156
|
z.object({ channelId: z.string(), conversationId: z.string() }).parse({ channelId, conversationId });
|
|
@@ -164,6 +196,12 @@ class BlobsTranscriptStore {
|
|
|
164
196
|
items: result.reduce((acc, activity) => (activity ? acc.concat(activity) : acc), []),
|
|
165
197
|
};
|
|
166
198
|
}
|
|
199
|
+
/**
|
|
200
|
+
* Lists all transcripts for a specific channel.
|
|
201
|
+
* @param channelId - The ID of the channel.
|
|
202
|
+
* @param continuationToken - Optional token for paginated results.
|
|
203
|
+
* @returns A promise resolving to a paged result of transcript information.
|
|
204
|
+
*/
|
|
167
205
|
async listTranscripts(channelId, continuationToken) {
|
|
168
206
|
var _a, _b, _c, _d;
|
|
169
207
|
z.object({ channelId: z.string() }).parse({ channelId });
|
|
@@ -196,6 +234,12 @@ class BlobsTranscriptStore {
|
|
|
196
234
|
items: result !== null && result !== void 0 ? result : [],
|
|
197
235
|
};
|
|
198
236
|
}
|
|
237
|
+
/**
|
|
238
|
+
* Deletes all transcripts for a specific conversation.
|
|
239
|
+
* @param channelId - The ID of the channel.
|
|
240
|
+
* @param conversationId - The ID of the conversation.
|
|
241
|
+
* @returns A promise that resolves when the deletion is complete.
|
|
242
|
+
*/
|
|
199
243
|
async deleteTranscript(channelId, conversationId) {
|
|
200
244
|
var _a, _b, _c;
|
|
201
245
|
z.object({ channelId: z.string(), conversationId: z.string() }).parse({ channelId, conversationId });
|
|
@@ -216,6 +260,12 @@ class BlobsTranscriptStore {
|
|
|
216
260
|
page = await iter.next();
|
|
217
261
|
}
|
|
218
262
|
}
|
|
263
|
+
/**
|
|
264
|
+
* Logs an activity to the transcript store.
|
|
265
|
+
* @param activity - The activity to log.
|
|
266
|
+
* @param options - Optional configuration options for the operation.
|
|
267
|
+
* @returns A promise that resolves when the activity is logged.
|
|
268
|
+
*/
|
|
219
269
|
async logActivity(activity, options) {
|
|
220
270
|
var _a, _b, _c, _d;
|
|
221
271
|
z.object({ activity: z.record(z.unknown()) }).parse({ activity });
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"blobsTranscriptStore.js","sourceRoot":"","sources":["../../src/blobsTranscriptStore.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"blobsTranscriptStore.js","sourceRoot":"","sources":["../../src/blobsTranscriptStore.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4DA,0CAeC;AAED,8BAMC;AAnFD,uCAAwB;AACxB,iEAA8C;AAG9C,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,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,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;;;;;;;OAOG;IACH,YACE,gBAAwB,EACxB,aAAqB,EACrB,OAAqC,EACrC,cAAc,GAAG,EAAE,EACnB,eAAkE;QAjBnD,iBAAY,GAAG,QAAQ,CAAA;QAEhC,2BAAsB,GAAa,KAAK,CAAA;QAiB9C,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;;;;;;;OAOG;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,EAAE,GAAG,QAAQ,EAAE,SAAS,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAc,CAAA;gBAC7E,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;;;;;OAKG;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;;;;;OAKG;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;;;;;OAKG;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;AAzPD,oDAyPC"}
|
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": "0.
|
|
4
|
+
"version": "0.3.5",
|
|
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": "0.
|
|
20
|
+
"@microsoft/agents-hosting": "0.3.5"
|
|
21
21
|
},
|
|
22
22
|
"license": "MIT",
|
|
23
23
|
"files": [
|
|
@@ -12,6 +12,11 @@ import {
|
|
|
12
12
|
} from '@azure/storage-blob'
|
|
13
13
|
import { TranscriptStore, PagedResult, TranscriptInfo } from '@microsoft/agents-hosting'
|
|
14
14
|
|
|
15
|
+
/**
|
|
16
|
+
* Formats a Date object into a hexadecimal string representing ticks.
|
|
17
|
+
* @param timestamp - The Date object to format.
|
|
18
|
+
* @returns A string representing the formatted ticks.
|
|
19
|
+
*/
|
|
15
20
|
function formatTicks (timestamp: Date): string {
|
|
16
21
|
const epochTicks = 621355968000000000
|
|
17
22
|
const ticksPerMillisecond = 10000
|
|
@@ -19,10 +24,21 @@ function formatTicks (timestamp: Date): string {
|
|
|
19
24
|
return ticks.toString(16)
|
|
20
25
|
}
|
|
21
26
|
|
|
27
|
+
/**
|
|
28
|
+
* Generates a sanitized prefix for a channel.
|
|
29
|
+
* @param channelId - The ID of the channel.
|
|
30
|
+
* @returns A sanitized string prefix for the channel.
|
|
31
|
+
*/
|
|
22
32
|
function getChannelPrefix (channelId: string): string {
|
|
23
33
|
return sanitizeBlobKey(`${channelId}/`)
|
|
24
34
|
}
|
|
25
35
|
|
|
36
|
+
/**
|
|
37
|
+
* Generates a sanitized prefix for a conversation within a channel.
|
|
38
|
+
* @param channelId - The ID of the channel.
|
|
39
|
+
* @param conversationId - The ID of the conversation.
|
|
40
|
+
* @returns A sanitized string prefix for the conversation.
|
|
41
|
+
*/
|
|
26
42
|
function getConversationPrefix (channelId: string, conversationId: string): string {
|
|
27
43
|
return sanitizeBlobKey(`${channelId}/${conversationId}`)
|
|
28
44
|
}
|
|
@@ -73,7 +89,14 @@ const MAX_PAGE_SIZE = 20
|
|
|
73
89
|
* Options for configuring the BlobsTranscriptStore.
|
|
74
90
|
*/
|
|
75
91
|
export interface BlobsTranscriptStoreOptions {
|
|
92
|
+
/**
|
|
93
|
+
* Optional pipeline options for configuring the Azure Blob Storage client.
|
|
94
|
+
*/
|
|
76
95
|
storagePipelineOptions?: StoragePipelineOptions;
|
|
96
|
+
|
|
97
|
+
/**
|
|
98
|
+
* Indicates whether to decode the transcript key when retrieving transcripts.
|
|
99
|
+
*/
|
|
77
100
|
decodeTranscriptKey?: boolean;
|
|
78
101
|
}
|
|
79
102
|
|
|
@@ -86,6 +109,14 @@ export class BlobsTranscriptStore implements TranscriptStore {
|
|
|
86
109
|
private _initializePromise?: Promise<unknown>
|
|
87
110
|
private _isDecodeTranscriptKey?: boolean = false
|
|
88
111
|
|
|
112
|
+
/**
|
|
113
|
+
* Constructs a new instance of the BlobsTranscriptStore class.
|
|
114
|
+
* @param connectionString - The connection string for the Azure Blob Storage account.
|
|
115
|
+
* @param containerName - The name of the container to use for storing transcripts.
|
|
116
|
+
* @param options - Optional configuration options for the store.
|
|
117
|
+
* @param blobServiceUri - Optional URI for the blob service.
|
|
118
|
+
* @param tokenCredential - Optional credentials for authenticating with the blob service.
|
|
119
|
+
*/
|
|
89
120
|
constructor (
|
|
90
121
|
connectionString: string,
|
|
91
122
|
containerName: string,
|
|
@@ -134,6 +165,14 @@ export class BlobsTranscriptStore implements TranscriptStore {
|
|
|
134
165
|
return this._initializePromise
|
|
135
166
|
}
|
|
136
167
|
|
|
168
|
+
/**
|
|
169
|
+
* Retrieves transcript activities for a specific conversation.
|
|
170
|
+
* @param channelId - The ID of the channel.
|
|
171
|
+
* @param conversationId - The ID of the conversation.
|
|
172
|
+
* @param continuationToken - Optional token for paginated results.
|
|
173
|
+
* @param startDate - Optional start date to filter activities.
|
|
174
|
+
* @returns A promise resolving to a paged result of activities.
|
|
175
|
+
*/
|
|
137
176
|
async getTranscriptActivities (
|
|
138
177
|
channelId: string,
|
|
139
178
|
conversationId: string,
|
|
@@ -202,6 +241,12 @@ export class BlobsTranscriptStore implements TranscriptStore {
|
|
|
202
241
|
}
|
|
203
242
|
}
|
|
204
243
|
|
|
244
|
+
/**
|
|
245
|
+
* Lists all transcripts for a specific channel.
|
|
246
|
+
* @param channelId - The ID of the channel.
|
|
247
|
+
* @param continuationToken - Optional token for paginated results.
|
|
248
|
+
* @returns A promise resolving to a paged result of transcript information.
|
|
249
|
+
*/
|
|
205
250
|
async listTranscripts (channelId: string, continuationToken?: string): Promise<PagedResult<TranscriptInfo>> {
|
|
206
251
|
z.object({ channelId: z.string() }).parse({ channelId })
|
|
207
252
|
|
|
@@ -242,6 +287,12 @@ export class BlobsTranscriptStore implements TranscriptStore {
|
|
|
242
287
|
}
|
|
243
288
|
}
|
|
244
289
|
|
|
290
|
+
/**
|
|
291
|
+
* Deletes all transcripts for a specific conversation.
|
|
292
|
+
* @param channelId - The ID of the channel.
|
|
293
|
+
* @param conversationId - The ID of the conversation.
|
|
294
|
+
* @returns A promise that resolves when the deletion is complete.
|
|
295
|
+
*/
|
|
245
296
|
async deleteTranscript (channelId: string, conversationId: string): Promise<void> {
|
|
246
297
|
z.object({ channelId: z.string(), conversationId: z.string() }).parse({ channelId, conversationId })
|
|
247
298
|
|
|
@@ -270,6 +321,12 @@ export class BlobsTranscriptStore implements TranscriptStore {
|
|
|
270
321
|
}
|
|
271
322
|
}
|
|
272
323
|
|
|
324
|
+
/**
|
|
325
|
+
* Logs an activity to the transcript store.
|
|
326
|
+
* @param activity - The activity to log.
|
|
327
|
+
* @param options - Optional configuration options for the operation.
|
|
328
|
+
* @returns A promise that resolves when the activity is logged.
|
|
329
|
+
*/
|
|
273
330
|
async logActivity (activity: Activity, options?: BlobsTranscriptStoreOptions): Promise<void> {
|
|
274
331
|
z.object({ activity: z.record(z.unknown()) }).parse({ activity })
|
|
275
332
|
|