@bwat47/joplin-plugin-scripts 1.1.0 → 1.2.0

package/types/packagePlugin.d.mts

@@ -0,0 +1,61 @@
+/**
+ * Reads `package.json` and `src/manifest.json` from `root` and validates the fields the plugin
+ * repository depends on: plugin ID, matching versions, package name and keyword, categories, and
+ * local screenshots.
+ * @param {string} root Plugin project root.
+ * @returns {Promise<{ packageJson: PackageMetadata, manifest: PluginManifest }>}
+ */
+export function readProject(root: string): Promise<{
+    packageJson: PackageMetadata;
+    manifest: PluginManifest;
+}>;
+/**
+ * Archives `<root>/dist` into `<root>/publish/<id>.jpl` and writes `<id>.json` publish metadata.
+ * `extraScripts` are bundle paths relative to `dist/` that must exist before packaging.
+ * @param {string} root Plugin project root.
+ * @param {PluginManifest} manifest Validated plugin manifest, including its plugin ID.
+ * @param {string[]} [extraScripts] Required bundle paths relative to `dist/`.
+ */
+export function packagePlugin(root: string, manifest: PluginManifest, extraScripts?: string[]): Promise<void>;
+/**
+ * Package metadata used by the build and version commands. Other fields are preserved.
+ * @typedef {object} PackageMetadata
+ * @property {string} name
+ * @property {string} version
+ * @property {string[]} [keywords]
+ */
+/**
+ * Plugin manifest fields used by validation and packaging. Other fields are preserved.
+ * @typedef {object} PluginManifest
+ * @property {string} id
+ * @property {string} version
+ * @property {string[]} [categories]
+ * @property {{ src: string }[]} [screenshots] Local or remote screenshots.
+ */
+/**
+ * Plugin repository categories accepted in `manifest.categories`.
+ * Mirrors generator-joplin's list; `update-api` warns when they differ.
+ */
+export const VALID_CATEGORIES: Set<string>;
+/**
+ * Package metadata used by the build and version commands. Other fields are preserved.
+ */
+export type PackageMetadata = {
+    name: string;
+    version: string;
+    keywords?: string[] | undefined;
+};
+/**
+ * Plugin manifest fields used by validation and packaging. Other fields are preserved.
+ */
+export type PluginManifest = {
+    id: string;
+    version: string;
+    categories?: string[] | undefined;
+    /**
+     * Local or remote screenshots.
+     */
+    screenshots?: {
+        src: string;
+    }[] | undefined;
+};

package/types/updateApi.d.mts

@@ -0,0 +1,32 @@
+/**
+ * Compares the hand-maintained category and content-script external lists with the ones in
+ * generator-joplin's `webpack.config.js` text. Returns one warning per list that differs or
+ * cannot be found; an empty array means both match.
+ * @param {string} webpackConfig
+ * @returns {string[]}
+ */
+export function compareGeneratorLists(webpackConfig: string): string[];
+/**
+ * Replaces `<root>/api` with a copy of `source`. The copy is staged next to `api/` and swapped in
+ * by rename, so a failed copy leaves the existing `api/` untouched. `copy` defaults to a recursive copy.
+ * @param {string} root Plugin project root.
+ * @param {string} source
+ * @param {CopyDirectory} [copy] Copies the API into the staging directory.
+ */
+export function replaceApi(root: string, source: string, copy?: CopyDirectory): Promise<void>;
+/**
+ * Replaces `<root>/api` with the API declarations from the latest generator-joplin package.
+ * Nothing else in the project is touched. Returns the generator version used and warnings for
+ * hand-maintained build lists that no longer match the generator.
+ * @param {string} root Plugin project root.
+ * @param {string} [packageSpec] npm package specification for the generator to download.
+ * @returns {Promise<{ version: string, warnings: string[] }>}
+ */
+export function updateApi(root: string, packageSpec?: string): Promise<{
+    version: string;
+    warnings: string[];
+}>;
+/**
+ * Copies a source directory into a destination directory.
+ */
+export type CopyDirectory = (from: string, to: string) => Promise<void>;

package/types/updateVersion.d.mts

@@ -0,0 +1,7 @@
+/**
+ * Increments the patch version in `package.json`, `src/manifest.json`, and `package-lock.json`
+ * together. Writes nothing unless all three files can be updated.
+ * @param {string} root Plugin project root.
+ * @returns {Promise<string>} The new version.
+ */
+export function updateVersion(root: string): Promise<string>;