@epinova/opticli 0.0.0-stage → 0.28.0

package/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in 
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

package/README.md

@@ -1,3 +1,182 @@
-# Temporary Holding Version
+# opticli for Node.js and Playwright
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Typed access to [opticli](https://github.com/epinova/opticli) from Node.js, and Playwright fixtures that use it: start
+an Optimizely CMS 12 or 13 site, seed the content the tests need, give each test content of its own, and clean up
+after. Writes go through the CMS (versions, cache, events), so a page shows a change at once.
+
+## Install
+
+```bash
+npm install -D @epinova/opticli
+```
+
+The package runs the opticli CLI; it doesn't install it. Its version is the opticli version it was released with, and it
+needs that opticli or newer: pin it in
+the site's repository with a [local tool manifest](https://learn.microsoft.com/dotnet/core/tools/local-tools-how-to-use),
+so CI gets the same version:
+
+```bash
+dotnet new tool-manifest
+dotnet tool install OptiCli
+```
+
+or install it globally (`dotnet tool install -g OptiCli`). opticli's own rules apply: the site runs against your local
+or chosen development database (`opticli doctor` shows which), never production.
+
+## Playwright
+
+A seed plan: content every test can read. It is an [opticli plan](https://github.com/epinova/opticli/blob/main/skill/reference.md#plans-apply)
+that setup applies with `--update-existing` on every run, so the first run creates it and later runs only repair what
+changed. Give it a fixed `guidNamespace` and an `id` on each step that creates something.
+
+```ts
+// e2e/seed.ts
+import type { Plan } from '@epinova/opticli';
+
+export const seedPlan = {
+  guidNamespace: '0d6a8a5e-2f7b-4c1e-9b0a-5c3f1e7d2a61', // any GUID; keep it
+  operations: [
+    { op: 'create', id: 'root', parent: '/en/', type: 'StandardPage', name: 'Test fixtures', properties: { PageVisibleInMenu: false } },
+    { op: 'upload', id: 'image', file: 'files/teaser.png', for: '$root' },
+    { op: 'create', id: 'article', parent: '$root', type: 'ArticlePage', name: 'Seeded article', properties: { MainBody: '<p>Hello</p>' } },
+  ],
+} as const satisfies Plan;
+```
+
+```ts
+// e2e/global-setup.ts
+import { defineSetup } from '@epinova/opticli/playwright';
+import { seedPlan } from './seed.ts';
+
+export default defineSetup({ plan: seedPlan, planDir: import.meta.dirname });
+```
+
+```ts
+// playwright.config.ts
+import { defineConfig } from '@playwright/test';
+import type { OptiCliWorkerOptions } from '@epinova/opticli/playwright';
+
+export default defineConfig<{}, OptiCliWorkerOptions>({
+  testDir: './e2e',
+  globalSetup: './e2e/global-setup.ts',
+  use: {
+    // Each worker's test content goes below a hidden page of its own, below the seed plan's root.
+    opticliSandbox: { parent: '$root', type: 'StandardPage', properties: { PageVisibleInMenu: false } },
+  },
+});
+```
+
+```ts
+// e2e/fixtures.ts: seed.refs and seed.urls typed by the plan's step ids
+import { createTest } from '@epinova/opticli/playwright';
+import type { seedPlan } from './seed.ts';
+
+export const test = createTest<typeof seedPlan>();
+export { expect } from '@epinova/opticli/playwright';
+```
+
+```ts
+// e2e/article.spec.ts
+import { expect, test } from './fixtures.ts';
+
+test('the seeded article', async ({ page, seed }) => {
+  await page.goto(seed.urls.article!);
+  await expect(page.getByText('Hello')).toBeVisible();
+});
+
+test('a draft is not visible until it is published', async ({ page, cms }) => {
+  const created = await cms.page('StandardPage', 'Draft test', { MainBody: '<p>Published text</p>' });
+  const draft = await cms.set(created.ref, { MainBody: '<p>Draft text</p>' });
+
+  await page.goto(created.url);
+  await expect(page.getByText('Draft text')).toHaveCount(0);
+
+  await cms.publish(draft.version!);
+  await page.reload();
+  await expect(page.getByText('Draft text')).toBeVisible();
+});
+```
+
+### What setup does
+
+`defineSetup()` is the `globalSetup`. It starts the site with `opticli serve` (or reuses one that runs already: `serve`,
+or the site your IDE runs in IDE mode), checks that opticli and the site's agent are new enough, applies the seed plan,
+and points `baseURL` at the site. After the tests it stops a site it started, and leaves one that ran before. The seeded
+content stays for the next run.
+
+| Option | Default | |
+|---|---|---|
+| `plan` | none | The seed plan. |
+| `planDir` | the working directory | Where the plan's files are (`upload`, `"@file"` values); they must be inside it. |
+| `publish` | `true` | Publish what the plan saves. |
+| `build` | `OPTICLI_BUILD=1` | Build the site before starting it (`serve --build`). |
+| `keepSite` | `OPTICLI_KEEP_SITE=1` | Leave a site that setup started running. |
+| `opticli` | see below | `command`, `project`, `cwd`. |
+
+### Fixtures
+
+| Fixture | Scope | |
+|---|---|---|
+| `seed` | worker | `refs` and `urls` (host-relative) of the plan's steps, by `id`; `baseURL`. |
+| `cms` | test | Content for one test: `page(type, name, properties?, { parent?, publish?, keep? })` (published by default; returns `ref`, `version` and `url`), `set`, `publish`, `apply(plan, { keep?, ... })`. What `page` and `apply` create goes to the recycle bin after the test, unless `keep`. |
+| `sandbox` | worker | With the `opticliSandbox` option: the ref of the worker's own page, where `cms.page()` creates content. It goes to the recycle bin when the worker ends, with anything a failed test left. |
+| `opticli` | worker | The `OptiCli` client, for anything else. |
+| `baseURL` | test | The site `opticli serve` runs. |
+
+`opticliSandbox`: `parent` (a ref, or `$id` of a seed step), `type` (a page type the parent allows and that allows your
+test pages), `properties`. Without it, pass `{ parent }` to `cms.page()`.
+
+### What stays, and what goes
+
+| | After the test run |
+|---|---|
+| The seed plan | Stays. The next run repairs what changed. |
+| `cms.page()`, `cms.apply()` | Go after the test. With `keep: true`, stay. |
+| `cms.set()`, `cms.publish()` | Stay: they change content the test didn't make. On seeded content the next run's seed puts it back, but tests in other workers of the same run see the change. |
+| The sandbox | Goes when the worker ends, with everything below it, whatever made it. |
+| The `opticli` fixture, the Node.js client | Stay: they never remove anything (except below the sandbox, as above). |
+
+`keep: true` needs a parent outside the sandbox and outside content the test made, since that goes with everything
+below it; `cms` refuses it there before saving anything. A step of `cms.apply()` that found its content already there
+(`updateExisting`) leaves it, with or without `keep`.
+
+Deleted content goes to the recycle bin, as in the CMS: nothing is deleted for good. On a local database that is
+usually fine; empty the recycle bin in the CMS now and then.
+
+## Node.js
+
+```ts
+import { OptiCli, OptiCliError } from '@epinova/opticli';
+
+const cms = new OptiCli({ project: '../src/Site' });
+const page = await cms.create('/en/', 'StandardPage', 'Hello', { MainBody: '<p>Hi</p>' }, { publish: true });
+console.log(page.url); // /en/hello/
+
+try {
+  await cms.get('999999');
+} catch (e) {
+  if (e instanceof OptiCliError && e.code === 'not_found') console.log(e.hint);
+}
+```
+
+The client changes what you tell it to and removes nothing on its own, so it suits scripts that make content to keep.
+Typed methods: `serve`, `serveStatus`, `serveStop`, `get`, `url`, `create`, `set`, `publish`, `delete`, `apply`.
+`run(args)` runs any other command and returns its JSON envelope. A failure throws `OptiCliError` with opticli's `code`,
+`exitCode`, `hint`, `details` and `version`; see opticli's
+[exit codes](https://github.com/epinova/opticli#output-and-exit-codes).
+
+Every call runs opticli once (about a second, most of it .NET starting): fine for setup, and a plan (`apply`) does many
+changes in one call.
+
+### Which opticli, which site
+
+| | |
+|---|---|
+| `command` option or `OPTICLI` | The opticli to run: an executable, or a checkout's `opticli.dll` (run with `dotnet`). Otherwise `dotnet tool run opticli` when a tool manifest above the working directory has it, else `opticli` on PATH. |
+| `project` option or `OPTICLI_PROJECT` | The site's `.csproj` or folder, relative to `cwd` (default: the working directory). Otherwise opticli finds it from the working directory. |
+
+`apply` runs in `baseDir` (`planDir` in setup), so a tool manifest must be in or above that folder too.
+
+## Licence
+
+MPL-2.0, as opticli.

package/lib/index.d.ts

@@ -0,0 +1,4 @@
+export * from './types.ts';
+export { OptiCli, OptiCliError, compareVersions, findToolManifest, resolveCommand } from './opticli.ts';
+export type { OptiCliOptions, RunOptions, WriteOptions } from './opticli.ts';
+export { requiredOpticli, version } from './version.ts';

package/lib/index.js

@@ -0,0 +1,3 @@
+export * from "./types.js";
+export { OptiCli, OptiCliError, compareVersions, findToolManifest, resolveCommand } from "./opticli.js";
+export { requiredOpticli, version } from "./version.js";

package/lib/opticli.d.ts

@@ -0,0 +1,100 @@
+import type { ApplyResult, ContentItem, ContentRef, DeleteResult, ErrorBody, ErrorCode, OkEnvelope, Plan, Properties, ServeResult, UrlResult, WriteResult } from './types.ts';
+export interface OptiCliOptions {
+    /**
+     * How to run opticli, as the program and its first arguments. Default: `$OPTICLI` (an executable, or a checkout's
+     * `opticli.dll`), else `dotnet tool run opticli` when a local tool manifest (`.config/dotnet-tools.json`) above the
+     * working directory has opticli, else `opticli` on PATH.
+     */
+    command?: readonly string[];
+    /**
+     * The site's project (`--project`): its `.csproj` or folder, relative to `cwd`. Default: `$OPTICLI_PROJECT`, else
+     * opticli's discovery from the working directory.
+     */
+    project?: string;
+    /** Working directory for every call (except `apply`'s `baseDir`). Default: the process's. */
+    cwd?: string;
+    /** Called with `meta.warnings` of every successful command. */
+    onWarnings?: (warnings: string[], args: readonly string[]) => void;
+}
+export interface RunOptions {
+    /** Text for stdin (`apply -`). */
+    input?: string;
+    /** Working directory for this call. */
+    cwd?: string;
+    timeoutMs?: number;
+}
+export interface WriteOptions {
+    publish?: boolean;
+    dryRun?: boolean;
+    lang?: string;
+}
+/** opticli answered `ok: false`, or didn't answer with JSON (`code` `internal`). */
+export declare class OptiCliError extends Error {
+    readonly code: ErrorCode;
+    readonly hint?: string;
+    readonly details?: Record<string, unknown>;
+    readonly exitCode: number | null;
+    /** The opticli version that failed, when it says (0.27.0 and newer). */
+    readonly version?: string;
+    readonly args: readonly string[];
+    constructor(error: ErrorBody, exitCode: number | null, args: readonly string[], version?: string);
+}
+export declare class OptiCli {
+    readonly command: readonly string[];
+    readonly project?: string;
+    readonly cwd?: string;
+    private readonly onWarnings?;
+    constructor(options?: OptiCliOptions);
+    /** Runs any opticli command with `--json` and returns its envelope; throws OptiCliError when `ok` is false. */
+    run<T>(args: readonly string[], options?: RunOptions): Promise<OkEnvelope<T>>;
+    private data;
+    /** Starts the site with the site agent in the background (`serve`), or returns the one that runs. */
+    serve(options?: {
+        build?: boolean;
+        port?: number;
+        https?: boolean;
+        timeoutSeconds?: number;
+    }): Promise<OkEnvelope<ServeResult>>;
+    serveStatus(): Promise<ServeResult>;
+    serveStop(): Promise<ServeResult>;
+    get(ref: ContentRef, options?: {
+        lang?: string;
+        version?: 'published' | 'latest' | (string & {});
+        full?: boolean;
+    }): Promise<ContentItem>;
+    /** Every language branch's path and absolute URL. Write results have `url` already. */
+    url(ref: ContentRef): Promise<UrlResult>;
+    create(parent: ContentRef, type: string, name: string, properties?: Properties, options?: WriteOptions): Promise<WriteResult>;
+    /** Saves a draft of the change, unless `publish`. */
+    set(ref: ContentRef, properties: Properties, options?: WriteOptions & {
+        name?: string;
+        from?: string;
+    }): Promise<WriteResult>;
+    /** Publishes the latest version, or the version `ref` names (`123_456`). */
+    publish(ref: ContentRef, options?: {
+        includeDraft?: boolean;
+        dryRun?: boolean;
+    }): Promise<WriteResult>;
+    /** Moves content, with everything below it, to the recycle bin. */
+    delete(ref: ContentRef, options?: {
+        ignoreReferences?: boolean;
+        dryRun?: boolean;
+    }): Promise<DeleteResult>;
+    /**
+     * Runs a plan, sent on stdin. Its files (`upload`, `"@file"` values) are relative to `baseDir` and must be inside it.
+     * With the plan's `guidNamespace` and `updateExisting`, running it again only changes what differs.
+     */
+    apply(plan: Plan, options?: {
+        baseDir?: string;
+        updateExisting?: boolean;
+        publish?: boolean;
+        dryRun?: boolean;
+    }): Promise<ApplyResult>;
+    private exec;
+}
+/** The command that runs opticli from `cwd`: see {@link OptiCliOptions.command}. */
+export declare function resolveCommand(cwd: string, env?: NodeJS.ProcessEnv): string[];
+/** The nearest local tool manifest above `cwd` that has opticli, as `dotnet tool run` finds it. */
+export declare function findToolManifest(cwd: string): string | undefined;
+/** Compares `major.minor.patch` versions, ignoring a prerelease suffix: negative, zero or positive. */
+export declare function compareVersions(a: string, b: string): number;