@auspex-ai/next 0.0.0-stage → 1.4.1

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/README.md

@@ -1,3 +1,50 @@
-# Temporary Holding Version
+# @auspex-ai/next
 
-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.
+Next.js アダプタ。ブラウザの計装(`@auspex-ai/core`)の Provider と、ビルド時にアイコン名・要素の参照を DOM へ書き込む `withAuspex`。
+
+## withAuspex
+
+```ts
+// next.config.ts
+import { withAuspex } from '@auspex-ai/next/config';
+
+export default withAuspex(nextConfig, { host: 'https://<受信口のドメイン>' });
+```
+
+- **できるだけ最も外側に置く。** `webpack` / `turbopack` のキーを落とすプラグインが外側にあると、ローダーが失われる。
+- 戻り値の型は入力に合わせる(オブジェクトならオブジェクト、関数なら async の関数)。二重に掛けても 1 回分になる。
+
+### 要素の参照(Design Doc #50)
+
+クリックされうる要素には、名前(ハンドラ名・パスなど)そのものではなく、名前の鍵付きハッシュ(`data-auspex-ref`)だけを書く。名前はビルドの終わりに Auspex へ登録し、受信口が参照から名前に引き直す。
+
+1. アプリの設定のページで**ビルド鍵**(`auspex_bk_...`)を発行する(発行時に 1 回だけ表示される)。
+2. ビルドの環境変数 `AUSPEX_BUILD_KEY` に置く。**CI の秘密に置き、`NEXT_PUBLIC_` を付けない**(付けるとバンドルに入り、鍵で参照を作れてしまう)。
+3. 登録の受け口 `host`(受信口と同じドメイン。https)を `withAuspex(cfg, { host })` か環境変数 `NEXT_PUBLIC_AUSPEX_HOST` で渡す。ビルド鍵を送るので https のみ(開発用の `http://localhost`・`http://127.0.0.1` は除く)。
+4. セルフホスト版で IAP の背後に置いた internal へ登録するときだけ、ビルドの環境変数を足す: `AUSPEX_INTERNAL_HOST`(internal の https の URL。あれば登録だけそちらへ送る。`host` が無くてもよい)と `AUSPEX_IAP_SERVICE_ACCOUNT`(IAP を通すサービスアカウントのメール。CI に Google の認証情報、プロジェクトに `google-auth-library` が要る。任意の peer 依存)。
+
+鍵か `host` が無い、`elementNames: false`、`next dev` のときは参照を書かない(手書きの `data-auspex-name` / `data-auspex-ref` を消すだけ)。本番のビルドで理由が分かる場合は警告を出す。
+
+### 登録の経路
+
+- 既定は Next の `compiler.runAfterProductionCompile`(本番のビルドの終わりに呼ばれる。Next 15.4.1 以上の安定版の webpack、16 以上)。既にある hook は先に呼ぶ。登録に失敗してもビルドは落とさず警告する。
+- hook が使えない Next(15.4.1 未満、版が判定できない、15.x の Turbopack)では `registerNames: 'cli'` を渡し、`next build` の後に CLI を流す:
+
+```ts
+export default withAuspex(nextConfig, { registerNames: 'cli' });
+```
+
+```sh
+next build && AUSPEX_BUILD_KEY=... auspex-register-names --host https://<受信口のドメイン>
+```
+
+CLI のオプション: `--host`(既定は `NEXT_PUBLIC_AUSPEX_HOST`。環境変数 `AUSPEX_INTERNAL_HOST` があればそちらを優先)、`--dist-dir`(既定 `.next`)、`--build-id`(既定は `<distDir>/BUILD_ID`。無い・128 文字超は自前の id)。登録の失敗では終了コード 0 のまま警告する。
+
+### オプション
+
+| オプション | 既定 | 内容 |
+| --- | --- | --- |
+| `iconNames` | `true` | `false` でアイコン名の参照(`data-auspex-icon-ref`)を書かない。参照は要素名と同じビルド鍵で計算し、名前は同じ登録(`icons`)でビルドの終わりに Auspex へ送る。鍵が無い・strip のときは何も書かない(手書きの `data-auspex-icon` は消える)。ライブラリの class から取る名前は今のまま |
+| `elementNames` | `true` | `false` で要素の参照を書かない |
+| `registerNames` | なし | `'cli'` で hook ではなく CLI で登録する |
+| `host` | `NEXT_PUBLIC_AUSPEX_HOST` | 登録の受け口 |