@atlaskit/editor-plugin-autocomplete 0.3.0 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @atlaskit/editor-plugin-autocomplete
 
+## 0.4.0
+
+### Minor Changes
+
+- [`603cd44e7b8c3`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/603cd44e7b8c3) -
+  Fetch vectors through media client
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 0.3.0
 
 ### Minor Changes

package/build/tsconfig.json

@@ -4,7 +4,6 @@
 		"paths": {},
 		"resolveJsonModule": true
 	},
-	"files": ["./url-module.d.ts"],
 	"include": ["../src/**/*.ts", "../src/**/*.tsx"],
 	"exclude": [
 		"../src/**/__tests__/*",

package/dist/cjs/pm-plugins/autocomplete-plugin.js

@@ -6,7 +6,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.createAutocompletePlugin = exports.autocompletePluginKey = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-var _wordVectors_10k = _interopRequireDefault(require("url:./data/word-vectors_10k.bin"));
 var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
 var _keymap = require("@atlaskit/editor-prosemirror/keymap");
 var _state = require("@atlaskit/editor-prosemirror/state");
@@ -15,9 +14,7 @@ var _ghostTextDecoration = require("./ghost-text-decoration");
 var _slowLaneClient = require("./slow-lane-client");
 var _textPredictor = require("./text-predictor");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
-function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; } // url: prefix is an Atlaspack/Parcel directive that resolves this file as an emitted
-// asset URL (content-hashed). For rspack, this is handled via staticAssetsLoader.
-// eslint-disable-next-line @repo/internal/import/no-unresolved
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 var SLOW_LANE_ENDPOINT = '/gateway/api/v1/autocomplete/typeahead-encodings';
 var autocompletePluginKey = exports.autocompletePluginKey = new _state.PluginKey('autocomplete');
 var DEBOUNCE_MS = 150;
@@ -305,7 +302,7 @@ var createAutocompletePlugin = exports.createAutocompletePlugin = function creat
         focus: function focus() {
           (0, _textPredictor.loadDefaultVocabulary)();
           (0, _textPredictor.loadVectorsAsync)({
-            vectorsUrl: _wordVectors_10k.default
+            getBinaryUrl: options === null || options === void 0 ? void 0 : options.getVectorsBinaryUrl
           }).catch(function () {});
           if (!hasIngestedPage) {
             hasIngestedPage = true;

package/dist/cjs/pm-plugins/text-predictor.js

@@ -705,33 +705,47 @@ var loadVectorsAsync = exports.loadVectorsAsync = /*#__PURE__*/function () {
           }
           return _context.abrupt("return");
         case 2:
-          if (options !== null && options !== void 0 && options.vectorsUrl) {
+          if (options !== null && options !== void 0 && options.getBinaryUrl) {
             _context.next = 5;
             break;
           }
           // eslint-disable-next-line no-console
-          console.warn('[text-predictor] loadVectorsAsync called without a vectorsUrl — vectors will not load. Pass vectorsUrl via plugin options.');
+          console.warn('[text-predictor] loadVectorsAsync called without a getBinaryUrl — vectors will not load. Pass getVectorsBinaryUrl via plugin options.');
           return _context.abrupt("return");
         case 5:
           vectorsLoadStarted = true;
-          url = options.vectorsUrl;
-          _context.prev = 7;
-          _context.next = 10;
+          _context.prev = 6;
+          _context.next = 9;
+          return options.getBinaryUrl();
+        case 9:
+          url = _context.sent;
+          _context.next = 17;
+          break;
+        case 12:
+          _context.prev = 12;
+          _context.t0 = _context["catch"](6);
+          vectorsLoadStarted = false;
+          // eslint-disable-next-line no-console
+          console.warn('[text-predictor] Failed to resolve vectors URL:', _context.t0);
+          return _context.abrupt("return");
+        case 17:
+          _context.prev = 17;
+          _context.next = 20;
           return fetch(url);
-        case 10:
+        case 20:
           res = _context.sent;
           if (res.ok) {
-            _context.next = 15;
+            _context.next = 25;
             break;
           }
           vectorsLoadStarted = false;
           // eslint-disable-next-line no-console
           console.warn("[text-predictor] Failed to load vectors: ".concat(res.status));
           return _context.abrupt("return");
-        case 15:
-          _context.next = 17;
+        case 25:
+          _context.next = 27;
           return res.arrayBuffer();
-        case 17:
+        case 27:
           buffer = _context.sent;
           float32 = new Float32Array(buffer);
           wordIndex = _word_index_10k.default;
@@ -751,19 +765,19 @@ var loadVectorsAsync = exports.loadVectorsAsync = /*#__PURE__*/function () {
               sizeBytes: float32.byteLength
             });
           }
-          _context.next = 31;
+          _context.next = 41;
           break;
-        case 27:
-          _context.prev = 27;
-          _context.t0 = _context["catch"](7);
+        case 37:
+          _context.prev = 37;
+          _context.t1 = _context["catch"](17);
           vectorsLoadStarted = false;
           // eslint-disable-next-line no-console
-          console.warn('[text-predictor] Failed to load vectors:', _context.t0);
-        case 31:
+          console.warn('[text-predictor] Failed to load vectors:', _context.t1);
+        case 41:
         case "end":
           return _context.stop();
       }
-    }, _callee, null, [[7, 27]]);
+    }, _callee, null, [[6, 12], [17, 37]]);
   }));
   return function loadVectorsAsync(_x) {
     return _ref4.apply(this, arguments);

package/dist/es2019/pm-plugins/autocomplete-plugin.js

@@ -1,7 +1,3 @@
-// url: prefix is an Atlaspack/Parcel directive that resolves this file as an emitted
-// asset URL (content-hashed). For rspack, this is handled via staticAssetsLoader.
-// eslint-disable-next-line @repo/internal/import/no-unresolved
-import wordVectorsUrl from 'url:./data/word-vectors_10k.bin';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { keydownHandler } from '@atlaskit/editor-prosemirror/keymap';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
@@ -307,7 +303,7 @@ export const createAutocompletePlugin = options => {
         focus: () => {
           loadDefaultVocabulary();
           loadVectorsAsync({
-            vectorsUrl: wordVectorsUrl
+            getBinaryUrl: options === null || options === void 0 ? void 0 : options.getVectorsBinaryUrl
           }).catch(() => {});
           if (!hasIngestedPage) {
             hasIngestedPage = true;

package/dist/es2019/pm-plugins/text-predictor.js

@@ -569,13 +569,21 @@ export const loadVectorsAsync = async options => {
   if (vectorStore || vectorsLoadStarted) {
     return;
   }
-  if (!(options !== null && options !== void 0 && options.vectorsUrl)) {
+  if (!(options !== null && options !== void 0 && options.getBinaryUrl)) {
     // eslint-disable-next-line no-console
-    console.warn('[text-predictor] loadVectorsAsync called without a vectorsUrl — vectors will not load. Pass vectorsUrl via plugin options.');
+    console.warn('[text-predictor] loadVectorsAsync called without a getBinaryUrl — vectors will not load. Pass getVectorsBinaryUrl via plugin options.');
     return;
   }
   vectorsLoadStarted = true;
-  const url = options.vectorsUrl;
+  let url;
+  try {
+    url = await options.getBinaryUrl();
+  } catch (e) {
+    vectorsLoadStarted = false;
+    // eslint-disable-next-line no-console
+    console.warn('[text-predictor] Failed to resolve vectors URL:', e);
+    return;
+  }
   try {
     const res = await fetch(url);
     if (!res.ok) {

package/dist/esm/pm-plugins/autocomplete-plugin.js

@@ -1,10 +1,6 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
-// url: prefix is an Atlaspack/Parcel directive that resolves this file as an emitted
-// asset URL (content-hashed). For rspack, this is handled via staticAssetsLoader.
-// eslint-disable-next-line @repo/internal/import/no-unresolved
-import wordVectorsUrl from 'url:./data/word-vectors_10k.bin';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { keydownHandler } from '@atlaskit/editor-prosemirror/keymap';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
@@ -299,7 +295,7 @@ export var createAutocompletePlugin = function createAutocompletePlugin(options)
         focus: function focus() {
           loadDefaultVocabulary();
           loadVectorsAsync({
-            vectorsUrl: wordVectorsUrl
+            getBinaryUrl: options === null || options === void 0 ? void 0 : options.getVectorsBinaryUrl
           }).catch(function () {});
           if (!hasIngestedPage) {
             hasIngestedPage = true;

package/dist/esm/pm-plugins/text-predictor.js

@@ -702,33 +702,47 @@ export var loadVectorsAsync = /*#__PURE__*/function () {
           }
           return _context.abrupt("return");
         case 2:
-          if (options !== null && options !== void 0 && options.vectorsUrl) {
+          if (options !== null && options !== void 0 && options.getBinaryUrl) {
             _context.next = 5;
             break;
           }
           // eslint-disable-next-line no-console
-          console.warn('[text-predictor] loadVectorsAsync called without a vectorsUrl — vectors will not load. Pass vectorsUrl via plugin options.');
+          console.warn('[text-predictor] loadVectorsAsync called without a getBinaryUrl — vectors will not load. Pass getVectorsBinaryUrl via plugin options.');
           return _context.abrupt("return");
         case 5:
           vectorsLoadStarted = true;
-          url = options.vectorsUrl;
-          _context.prev = 7;
-          _context.next = 10;
+          _context.prev = 6;
+          _context.next = 9;
+          return options.getBinaryUrl();
+        case 9:
+          url = _context.sent;
+          _context.next = 17;
+          break;
+        case 12:
+          _context.prev = 12;
+          _context.t0 = _context["catch"](6);
+          vectorsLoadStarted = false;
+          // eslint-disable-next-line no-console
+          console.warn('[text-predictor] Failed to resolve vectors URL:', _context.t0);
+          return _context.abrupt("return");
+        case 17:
+          _context.prev = 17;
+          _context.next = 20;
           return fetch(url);
-        case 10:
+        case 20:
           res = _context.sent;
           if (res.ok) {
-            _context.next = 15;
+            _context.next = 25;
             break;
           }
           vectorsLoadStarted = false;
           // eslint-disable-next-line no-console
           console.warn("[text-predictor] Failed to load vectors: ".concat(res.status));
           return _context.abrupt("return");
-        case 15:
-          _context.next = 17;
+        case 25:
+          _context.next = 27;
           return res.arrayBuffer();
-        case 17:
+        case 27:
           buffer = _context.sent;
           float32 = new Float32Array(buffer);
           wordIndex = wordIndexData;
@@ -748,19 +762,19 @@ export var loadVectorsAsync = /*#__PURE__*/function () {
               sizeBytes: float32.byteLength
             });
           }
-          _context.next = 31;
+          _context.next = 41;
           break;
-        case 27:
-          _context.prev = 27;
-          _context.t0 = _context["catch"](7);
+        case 37:
+          _context.prev = 37;
+          _context.t1 = _context["catch"](17);
           vectorsLoadStarted = false;
           // eslint-disable-next-line no-console
-          console.warn('[text-predictor] Failed to load vectors:', _context.t0);
-        case 31:
+          console.warn('[text-predictor] Failed to load vectors:', _context.t1);
+        case 41:
         case "end":
           return _context.stop();
       }
-    }, _callee, null, [[7, 27]]);
+    }, _callee, null, [[6, 12], [17, 37]]);
   }));
   return function loadVectorsAsync(_x) {
     return _ref4.apply(this, arguments);

package/dist/types/pm-plugins/autocomplete-plugin.d.ts

@@ -32,5 +32,11 @@ export interface AutocompletePluginOptions {
      * word-frequency boosting. Called lazily so the preset can remain synchronous.
      */
     getContext?: () => Promise<AutocompleteContext | undefined>;
+    /**
+     * Async function that resolves to a URL for the word vectors binary file.
+     * When provided, this takes precedence over the bundled asset URL.
+     * Use this to serve vectors from a CDN or media service in production.
+     */
+    getVectorsBinaryUrl?: () => Promise<string>;
 }
-export declare const createAutocompletePlugin: (options?: AutocompletePluginOptions) => SafePlugin<any>;
+export declare const createAutocompletePlugin: (options?: AutocompletePluginOptions) => SafePlugin<AutocompletePluginState>;

package/dist/types/pm-plugins/text-predictor.d.ts

@@ -83,7 +83,7 @@ export declare const incrementSessionFreq: (word: string) => void;
 export declare const ingestDocumentPage: (pageContent: string | undefined) => void;
 export declare const predict: (textBefore: string) => string | null;
 export declare const loadVectorsAsync: (options?: {
-    vectorsUrl?: string;
+    getBinaryUrl?: () => Promise<string>;
 }) => Promise<void>;
 export declare const initVectors: (store: VectorStore) => void;
 export declare const loadDefaultVocabulary: () => void;

package/dist/types-ts4.5/pm-plugins/autocomplete-plugin.d.ts

@@ -32,5 +32,11 @@ export interface AutocompletePluginOptions {
      * word-frequency boosting. Called lazily so the preset can remain synchronous.
      */
     getContext?: () => Promise<AutocompleteContext | undefined>;
+    /**
+     * Async function that resolves to a URL for the word vectors binary file.
+     * When provided, this takes precedence over the bundled asset URL.
+     * Use this to serve vectors from a CDN or media service in production.
+     */
+    getVectorsBinaryUrl?: () => Promise<string>;
 }
-export declare const createAutocompletePlugin: (options?: AutocompletePluginOptions) => SafePlugin<any>;
+export declare const createAutocompletePlugin: (options?: AutocompletePluginOptions) => SafePlugin<AutocompletePluginState>;

package/dist/types-ts4.5/pm-plugins/text-predictor.d.ts

@@ -83,7 +83,7 @@ export declare const incrementSessionFreq: (word: string) => void;
 export declare const ingestDocumentPage: (pageContent: string | undefined) => void;
 export declare const predict: (textBefore: string) => string | null;
 export declare const loadVectorsAsync: (options?: {
-    vectorsUrl?: string;
+    getBinaryUrl?: () => Promise<string>;
 }) => Promise<void>;
 export declare const initVectors: (store: VectorStore) => void;
 export declare const loadDefaultVocabulary: () => void;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-autocomplete",
-	"version": "0.3.0",
+	"version": "0.4.0",
 	"description": "Client-side text autocomplete plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -33,7 +33,7 @@
 		"wink-nlp": "^2.4.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^112.16.0",
+		"@atlaskit/editor-common": "^112.18.0",
 		"react": "^18.2.0"
 	},
 	"techstack": {

package/src/pm-plugins/autocomplete-plugin.ts

@@ -1,8 +1,3 @@
-// url: prefix is an Atlaspack/Parcel directive that resolves this file as an emitted
-// asset URL (content-hashed). For rspack, this is handled via staticAssetsLoader.
-// eslint-disable-next-line @repo/internal/import/no-unresolved
-import wordVectorsUrl from 'url:./data/word-vectors_10k.bin';
-
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { keydownHandler } from '@atlaskit/editor-prosemirror/keymap';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
@@ -171,6 +166,12 @@ export interface AutocompletePluginOptions {
 	 * word-frequency boosting. Called lazily so the preset can remain synchronous.
 	 */
 	getContext?: () => Promise<AutocompleteContext | undefined>;
+	/**
+	 * Async function that resolves to a URL for the word vectors binary file.
+	 * When provided, this takes precedence over the bundled asset URL.
+	 * Use this to serve vectors from a CDN or media service in production.
+	 */
+	getVectorsBinaryUrl?: () => Promise<string>;
 }
 
 /**
@@ -374,7 +375,7 @@ export const createAutocompletePlugin = (options?: AutocompletePluginOptions) =>
 				},
 				focus: () => {
 					loadDefaultVocabulary();
-					loadVectorsAsync({ vectorsUrl: wordVectorsUrl }).catch(() => {});
+					loadVectorsAsync({ getBinaryUrl: options?.getVectorsBinaryUrl }).catch(() => {});
 					if (!hasIngestedPage) {
 						hasIngestedPage = true;
 						if (options?.getContext) {

package/src/pm-plugins/text-predictor.ts

@@ -714,20 +714,31 @@ interface VocabularyJson {
 	>;
 }
 
-export const loadVectorsAsync = async (options?: { vectorsUrl?: string }): Promise<void> => {
+export const loadVectorsAsync = async (options?: {
+	getBinaryUrl?: () => Promise<string>;
+}): Promise<void> => {
 	if (vectorStore || vectorsLoadStarted) {
 		return;
 	}
-	if (!options?.vectorsUrl) {
+	if (!options?.getBinaryUrl) {
 		// eslint-disable-next-line no-console
 		console.warn(
-			'[text-predictor] loadVectorsAsync called without a vectorsUrl — vectors will not load. Pass vectorsUrl via plugin options.',
+			'[text-predictor] loadVectorsAsync called without a getBinaryUrl — vectors will not load. Pass getVectorsBinaryUrl via plugin options.',
 		);
 		return;
 	}
 	vectorsLoadStarted = true;
 
-	const url = options.vectorsUrl;
+	let url: string;
+	try {
+		url = await options.getBinaryUrl();
+	} catch (e) {
+		vectorsLoadStarted = false;
+		// eslint-disable-next-line no-console
+		console.warn('[text-predictor] Failed to resolve vectors URL:', e);
+		return;
+	}
+
 	try {
 		const res = await fetch(url);
 		if (!res.ok) {

package/tsconfig.app.json

@@ -1,6 +1,5 @@
 {
 	"extends": "../../../tsconfig.base.json",
-	"files": ["./build/url-module.d.ts"],
 	"include": ["./src/**/*.ts", "./src/**/*.tsx", "./src/**/*.json"],
 	"exclude": [
 		"**/docs/**/*",

package/tsconfig.json

@@ -1,6 +1,5 @@
 {
 	"extends": "../../../tsconfig.json",
-	"files": ["./build/url-module.d.ts"],
 	"include": [
 		"src/**/*.ts",
 		"src/**/*.tsx"

package/build/url-module.d.ts

@@ -1,8 +0,0 @@
-// Ambient declaration for Atlaspack/Parcel url: prefix imports.
-// The url: prefix instructs the bundler to emit the referenced file as a
-// content-hashed asset and return its public URL as a string.
-// For rspack, this is handled via staticAssetsLoader config.
-declare module 'url:*' {
-	const url: string;
-	export default url;
-}