API 24 and tasks docs

.gitignore

@@ -8,9 +8,8 @@
 .docusaurus
 .cache-loader
 /docs/js-sdk/api
-/docs/js-sdk/examples/quickstart/*.ts
-/docs/js-sdk/examples/view-manifest/*.ts
-/docs/js-sdk/examples/view-manifest/*.html
+/docs/js-sdk/examples/*
+/docs/js-sdk/examples/*
 /docs/c2patool/*.md
 /docs/c2patool/docs/*.md
 /docs/c2pa-node/*.md
@@ -35,4 +34,4 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 
-.dccache
+.dccache

docs/tasks/build.mdx

@@ -0,0 +1,50 @@
+---
+id: build
+title: Attaching and signing a manifest
+hide_table_of_contents: true
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+import PythonBuild from './includes/_python-build.md';
+/*
+import NodeBuild from './includes/_node-build.md';
+*/
+import NodeWIP from './includes/_node-wip.md';
+import CppBuild from './includes/_cpp-build.md';
+import RustBuild from './includes/_rust-build.md';
+
+<Tabs groupId="programming-lang" queryString="lang">
+
+<TabItem value="js" label="JavaScript">
+
+You can't currently attach a manifest to an asset and sign the claim using the JavaScript library. You need to use a language that runs on the "back-end," such as Python, Node.js, C++, or Rust.
+
+</TabItem>
+
+<TabItem value="python" label="Python" default>
+
+<PythonBuild name="python-build" />
+
+</TabItem>
+
+<TabItem value="node" label="Node.js">
+
+<NodeWIP name="node-build" />
+
+</TabItem>
+
+<TabItem value="cpp" label="C++">
+
+<CppBuild name="cpp-build" />
+
+</TabItem>
+
+<TabItem value="rust" label="Rust">
+
+<RustBuild name="rust-build" />
+
+</TabItem>
+
+  </Tabs>

docs/tasks/get-resources.mdx

@@ -0,0 +1,52 @@
+---
+id: get-resources
+title: Getting resources from a manifest
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+import JSGetResources from './includes/_js-get-resources.md';
+import PythonGetResources from './includes/_python-get-resources.md';
+/*
+import NodeGetResources from './includes/_node-get-resources.md';
+*/
+import NodeWIP from './includes/_node-wip.md';
+import CppGetResources from './includes/_cpp-get-resources.md';
+import RustGetResources from './includes/_rust-get-resources.md';
+
+Manifest data can include binary resources such as thumbnail and icon images which are referenced by JUMBF URIs in manifest data.
+
+<Tabs groupId="programming-lang" queryString="lang">
+
+<TabItem value="js" label="JavaScript" default>
+
+<JSGetResources name="js-read" />
+
+</TabItem>
+
+<TabItem value="python" label="Python" default>
+
+<PythonGetResources name="python-read" />
+
+</TabItem>
+
+<TabItem value="node" label="Node.js">
+
+<NodeWIP name="node-read" />
+
+</TabItem>
+
+<TabItem value="cpp" label="C++">
+
+<CppGetResources name="cpp-read" />
+
+</TabItem>
+
+<TabItem value="rust" label="Rust">
+
+  <RustGetResources name="rust-read" />
+
+</TabItem>
+
+</Tabs>

docs/tasks/includes/_cpp-build.md

@@ -0,0 +1,29 @@
+This is an example of how to assign a manifest to an asset and sign the claim using C++:
+
+```cpp
+const std::string manifest_json = R"{
+    "claim_generator": "c2pa_c_test/0.1",
+    "claim_generator_info": [
+      {
+        "name": "c2pa-c test",
+        "version": "0.1"
+      }
+    ],
+    "assertions": [
+    {
+      "label": "c2pa.training-mining",
+      "data": {
+        "entries": {
+          "c2pa.ai_generative_training": { "use": "notAllowed" },
+          "c2pa.ai_inference": { "use": "notAllowed" },
+          "c2pa.ai_training": { "use": "notAllowed" },
+          "c2pa.data_mining": { "use": "notAllowed" }
+        }
+      }
+    }
+  ]
+ };
+
+auto builder = Builder(manifest_json);
+
+```

docs/tasks/includes/_cpp-get-resources.md

@@ -0,0 +1,72 @@
+This is how to get resources from a manifest using C++.
+
+```cpp
+string read_text_file(const fs::path &path)
+{
+    ifstream file(path);
+    if (!file.is_open())
+    {
+        throw runtime_error("Could not open file " + string(path));
+    }
+    string contents((istreambuf_iterator<char>(file)), istreambuf_iterator<char>());
+    file.close();
+    return contents.data();
+}
+
+int main()
+{
+  fs::path manifest_path = current_dir / "../tests/fixtures/training.json";
+  //fs::path certs_path = current_dir / "../tests/fixtures/es256_certs.pem";
+  //fs::path image_path = current_dir / "../tests/fixtures/A.jpg";
+  fs::path output_path = current_dir / "../target/example/training.jpg";
+  fs::path thumbnail_path = current_dir / "../target/example/thumbnail.jpg";
+
+  try
+      {
+          // load the manifest, certs, and private key
+      /* Commenting out, because not part of resource reading
+          string manifest_json = read_text_file(manifest_path).data();
+
+          string certs = read_text_file(certs_path).data();
+
+          // create a signer
+          Signer signer = Signer(&test_signer, Es256, certs, "http://timestamp.digicert.com");
+
+          auto builder = Builder(manifest_json);
+          auto manifest_data = builder.sign(image_path, output_path, signer);
+      */
+
+          // read the new manifest and display the JSON
+          auto reader = Reader(output_path);
+
+          auto manifest_store_json = reader.json();
+          cout << "The new manifest is " << manifest_store_json << endl;
+
+          // get the active manifest
+          json manifest_store = json::parse(manifest_store_json);
+          if (manifest_store.contains("active_manifest"))
+          {
+              string active_manifest = manifest_store["active_manifest"];
+              json &manifest = manifest_store["manifests"][active_manifest];
+
+              string identifer = manifest["thumbnail"]["identifier"];
+
+              reader.get_resource(identifer, thumbnail_path);
+
+              cout << "thumbnail written to" << thumbnail_path << endl;
+          }
+      }
+      catch (c2pa::Exception const &e)
+      {
+          cout << "C2PA Error: " << e.what() << endl;
+      }
+      catch (runtime_error const &e)
+      {
+          cout << "setup error" << e.what() << endl;
+      }
+      catch (json::parse_error const &e)
+      {
+          cout << "parse error " << e.what() << endl;
+      }
+}
+```

docs/tasks/includes/_cpp-read.md

@@ -0,0 +1,17 @@
+
+Use the `read_file` function to read C2PA data from the specified file. This function examines the specified asset file for C2PA data and returns a JSON report if it finds any; it throws exceptions on errors. If there are validation errors, the report includes a `validation_status` field.
+
+```cpp
+auto json_store = C2pa::read_file("<ASSET_FILE>", "<DATA_DIR>")
+```
+
+Where:
+
+- `<ASSET_FILE>`- The asset file to read.
+- `<DATA_DIR>` - Optional path to data output directory; If provided, the function extracts any binary resources, such as thumbnails, icons, and C2PA data into that directory. These files are referenced by the identifier fields in the manifest store report.
+
+For example:
+
+```cpp
+auto json_store = C2pa::read_file("work/media_file.jpg", "output/data_dir")
+```

docs/tasks/includes/_cpp-setup.md

@@ -0,0 +1,21 @@
+This is how to set up your code to use the C++ library:
+
+```cpp
+#include <iostream>
+#include <fstream>
+#include <string>
+#include <vector>
+#include <stdexcept>
+#include <openssl/evp.h>
+#include <openssl/pem.h>
+#include <openssl/err.h>
+#include "c2pa.hpp"
+#include "test_signer.hpp"
+#include <nlohmann/json.hpp>
+
+// this example uses nlohmann json for parsing the manifest
+using json = nlohmann::json;
+using namespace std;
+namespace fs = std::filesystem;
+using namespace c2pa;
+```