@nanoflags/cli 0.0.0-stage → 0.2.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,4 @@
+NanoFlags
+Copyright 2026 Alibtekarat Althkiya Company for Trading & Marketing (Intinovate)
+
+This product is licensed under the Apache License, Version 2.0 (see LICENSE).

package/README.md

@@ -1,3 +1,190 @@
-# Temporary Holding Version
+# @nanoflags/cli
 
-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.
+Command line for NanoFlags: export a project, create flags, evaluate flags locally, run scenario checks in CI,
+publish, upload flag code references, and remove resolved flags from code.
+
+```sh
+npx @nanoflags/cli --help        # or: npm install -g @nanoflags/cli && nanoflags --help
+# from this repository:
+pnpm install && pnpm --filter @nanoflags/cli build
+node packages/cli/dist/bin.js --help
+```
+
+Node 20 or newer. The only runtime dependency is `typescript` (used to read source files for
+`refs scan` and `cleanup`; it is loaded only by those commands). Releases are published to npm from
+[motazalmaroai/nanoflags-sdk](https://github.com/motazalmaroai/nanoflags-sdk) by its release
+workflow (`.github/workflows/release.yml`, tag `cli-v<version>`).
+
+## Authentication
+
+| | |
+| --- | --- |
+| `NANOFLAGS_KEY` / `--key` | A **CI key** (`nf_ci_…`: export, scenarios, code references) or an **admin key** (`nf_adm_…`: all of that, plus `flags create` and publish). SDK keys are refused by these endpoints. Prefer the environment variable — arguments are visible in process lists and shell history. |
+| `NANOFLAGS_BASE_URL` / `--base-url` | Edge URL. Default `https://edge.nanoflags.io`. Must be `https` (plain `http` only for `localhost`). |
+| `NANOFLAGS_SDK_KEY` / `--sdk-key` | Optional, only for `eval --source published`: a server SDK key; reads `/v1/bundle` instead of `/v1/ci/published`. |
+
+A key belongs to one environment of one project; commands act on that environment. The key is sent
+only as an `Authorization` header to the base URL and is never printed.
+
+Use a CI key in CI. It cannot publish, so a leaked CI key cannot change what your users get.
+
+## Exit codes
+
+| Code | Meaning |
+| --- | --- |
+| 0 | Success |
+| 1 | A check failed: a scenario failed, or a publish was refused |
+| 2 | Usage, configuration or key problem (missing/rejected key, wrong key kind, bad arguments, refused cleanup) |
+| 3 | NanoFlags could not be reached or answered with a server error |
+
+## Commands
+
+### `nanoflags export [--out <file>]`
+
+`GET /v1/admin/export`. Prints the project as JSON: flags (with `permanent`, `archived`, …), segments,
+environments, and the **draft** configuration of every environment. `--out` writes a file instead.
+The saved file can be passed to other commands with `--export <file>` to work offline.
+
+### `nanoflags flags list [--json]`
+
+Table of the project's flags: key, type, purpose, lifetime (permanent/temporary), client exposure, and
+on/off in the draft of the key's environment.
+
+### `nanoflags flags create <key> --type boolean|string|number|json [--default <json>] [--description <text>] [--name <text>] [--json]`
+
+`POST /v1/admin/flags` — creates a flag in the key's project. **Admin key only** (a CI key is refused
+before any request). Nothing is published: every environment's **draft** starts with the default value,
+and the flag reaches SDKs only with the next publish.
+
+```sh
+nanoflags flags create new-checkout --description "New checkout flow"            # boolean, default false
+nanoflags flags create theme --type string --default blue --name "Theme"         # bare word = string
+nanoflags flags create search-limit --type number --default 25
+nanoflags flags create ranker --type json --default '{"model":"v2","weights":[1,2]}'
+```
+
+- `--type` defaults to `boolean`; `--default` defaults to `false` for boolean flags and is required otherwise.
+- `--default` is JSON and must match the type. For string flags a value that is not JSON is taken as the
+  string itself (`--default blue` = `--default '"blue"'`).
+- The key follows the dashboard rules: lowercase letters, digits, `-` and `_`, starting with a letter or digit, at most 63.
+- `--name` defaults to the key. Purpose, owner, review date and client exposure are set in the dashboard.
+- The creation is recorded in the project's activity log with the key's name.
+
+| Refusal (exit 1) | Meaning |
+| --- | --- |
+| `CONFLICT` | A flag with this key already exists in the project. |
+| `INVALID_VALUE` | The default does not match the flag type. |
+
+### `nanoflags eval <flag> [--context <json>] [--source draft|published] [--fallback <json>] [--environment <key>] [--json]`
+
+Evaluates one flag **locally** with the NanoFlags engine — the same code the SDKs and the edge run —
+and prints the value, the reason and the trace.
+
+```sh
+nanoflags eval checkout-v2 --context '{"key":"u1","signedIn":true,"region":"US"}'
+# checkout-v2 = false
+# reason: rule_match · rule r1 (#1) · outside rollout (bucket 95.27)
+# source: draft of staging
+# trace: …
+```
+
+- `--source draft` (default): the draft from the export. `--environment` picks another environment's draft.
+- `--source published`: the published revision of the key's environment. With the CI or admin key
+  (`NANOFLAGS_KEY`) it is read from `GET /v1/ci/published`; when `NANOFLAGS_SDK_KEY` / `--sdk-key` (a server
+  SDK key) is set, the CLI instead reads exactly what SDKs receive (`GET /v1/bundle`). Same revision either way.
+- An unknown flag is not an error: the fallback (`--fallback`, default `null`) is printed with reason `flag_not_found`.
+
+### `nanoflags scenarios run [--source draft|revision] [--commit <sha>] [--run-url <url>] [--json]`
+
+`POST /v1/ci/scenarios/run`. NanoFlags evaluates every scenario marked "include in CI" against the
+draft (default) or the published revision, records the run, and returns the results. The command prints
+a table and exits **1 when any scenario fails**.
+
+In GitHub Actions, `--commit` and `--run-url` default from `GITHUB_SHA` and the run's URL, and a Markdown
+summary is appended to `GITHUB_STEP_SUMMARY`. See [`integrations/github-action`](../../integrations/github-action).
+
+### `nanoflags publish --expected-revision <n> [--note <text>]`
+
+`POST /v1/admin/publish` — publishes the draft of the key's environment. Admin key only.
+`--expected-revision` is the revision you believe is published now; if someone else published in the
+meantime nothing happens.
+
+| Refusal (exit 1) | Meaning |
+| --- | --- |
+| `DESTINATION_CHANGED` | The environment is at another revision than expected. Review, then retry with the new number. |
+| `NO_CHANGES` | The draft equals the published configuration. |
+| `CHANGE_REQUIRED` | The environment requires a reviewed change. Publish from the dashboard; keys cannot bypass review. |
+| `SCENARIOS_REQUIRED` | The environment requires passing scenarios on the current draft: run `nanoflags scenarios run --source draft` first. |
+
+### `nanoflags refs scan [dir] --repo <owner/name> [--commit <sha>] [--dry-run] [--json] [--max-file-size <bytes>]`
+
+Finds flag references in `.ts .tsx .js .jsx .mjs .cjs` files under `dir` (default `.`) and uploads them
+with `PUT /v1/ci/code-refs`, **replacing** the references previously stored for that repository.
+
+A reference is a call
+
+- whose callee name is `boolean`, `string`, `number`, `json`, `evaluate`, `useFlag`, `getBooleanValue`,
+  `getStringValue`, `getNumberValue`, `getObjectValue` or a `…Details` variant
+  (`flags.boolean(…)`, `client.getStringDetails(…)`, `useFlag(…)`), **and**
+- whose first argument is a string literal equal to a flag key of the project.
+
+Files are parsed with the TypeScript compiler; nothing is executed. Not found: keys built at run time,
+keys passed through variables or constants, wrappers with other names. Skipped: `node_modules`, `dist`,
+`build`, `.next`, `.git`, `.d.ts` files, symbolic links, and files above 1 MB (`--max-file-size`). At most
+5000 references are uploaded. Uploaded per reference: flag key, relative path, line, and the source line
+(up to 240 characters) — check that this is acceptable for your code before enabling it.
+
+`--dry-run` prints the references and uploads nothing. `--repo`/`--commit` default from
+`GITHUB_REPOSITORY`/`GITHUB_SHA`.
+
+### `nanoflags cleanup <flag> --value <json> [dir] [--write]`
+
+For a flag that is **permanently resolved to one value**, rewrites the code that still reads it.
+The default is a dry run that prints a unified diff; `--write` edits the files in place.
+
+```sh
+nanoflags cleanup checkout-v2 --value true src        # show the diff
+nanoflags cleanup checkout-v2 --value true src --write
+```
+
+What it does, for value-returning reads (`flags.boolean/string/number/json("key", …)`,
+`useFlag("key", <literal fallback>)`, awaited `getBooleanValue/…("key", …)`):
+
+| Pattern | Result |
+| --- | --- |
+| `if (<read>) A else B`, also negated, in `else if` chains, combined with `&&`/`\|\|` | the branch that runs; the other one is removed |
+| `<read> ? a : b` | `a` or `b` |
+| `<read> && x`, `<read> \|\| x`, `x && <read>` / `x \|\| <read>` in a condition | `x`, or the constant |
+| `<read> === "literal"` / `!==` | folded, then simplified as above |
+| `const on = <read>;` followed by uses of `on` | every use is treated like the read itself, then the declaration is removed (kept when exported) |
+| anything else (`let`, arguments, object properties, JSX attributes, loops) | the read is replaced with the literal |
+
+Limits, by design:
+
+- It **never commits, pushes, opens a pull request or merges**, and runs no other program. Review the
+  diff, run your tests, commit yourself.
+- It **refuses flags marked `permanent`** (kill switches, long-lived configuration) and values whose type
+  does not match the flag.
+- It prints every reference it did **not** transform, with the reason:
+  `evaluate()` / `…Details()` (they return an object), un-awaited `get…Value()` (may be a promise),
+  optional calls (`flags?.boolean(…)`), reads whose callee or arguments contain calls (dropping them
+  could drop a side effect), accessors of another type than the value (such a read returns its fallback
+  today), `useFlag` with a non-literal fallback.
+- Only literal flag keys are recognised — the same rule as `refs scan`. A flag read through a wrapper
+  or a constant is invisible to it.
+- It does not delete code that became unreachable after a `return`/`throw`; those places are listed.
+  It does not remove imports, variables or helpers that became unused, and it does not reformat: run
+  your linter and formatter afterwards.
+- A block's braces are kept when unwrapping it could change what a name refers to.
+- If a rewrite would leave a file with new syntax errors, that file is left untouched and reported.
+- It works on syntax, one file at a time, without type information. It is a proposal for a person to
+  review, not a proof.
+
+## Development
+
+```sh
+pnpm --filter @nanoflags/cli test        # mocked fetch + fixtures in test/fixtures
+pnpm --filter @nanoflags/cli typecheck
+pnpm --filter @nanoflags/cli build       # dist/bin.js
+UPDATE_FIXTURES=1 pnpm --filter @nanoflags/cli test   # re-record cleanup fixtures after an intended change
+```