@plattar/plattar-services
    TypeScript icon, indicating that this package has built-in type declarations

    1.120.1 • Public • Published

    Plattar Logo

    install size NPM License

    plattar-services allows interfacing with Remote Plattar Services such as Configurators, File Converters and Asset Optimisers.

    Quick Use

    // Minified Version ES2015 & ES2019 (Latest)
    https://cdn.jsdelivr.net/npm/@plattar/plattar-services/build/es2015/plattar-services.min.js
    https://cdn.jsdelivr.net/npm/@plattar/plattar-services/build/es2019/plattar-services.min.js
    
    // Standard Version ES2015 & ES2019 (Latest)
    https://cdn.jsdelivr.net/npm/@plattar/plattar-services/build/es2015/plattar-services.js
    https://cdn.jsdelivr.net/npm/@plattar/plattar-services/build/es2019/plattar-services.js

    Installation

    • Install using npm
    npm install @plattar/plattar-services

    Configurator Example

    const configurator = new PlattarServices.Configurator();
    
    // add SceneProduct and ProductVariation mapping to our configurator
    // if using plattar-api objects, the attributes will be hashed aswell
    configurator.addSceneProduct("e6d79450-4e5a-11ec-8441-19fd21954ae9", "568b63d0-3af6-11e9-8543-4d96b548a86f");
    configurator.addSceneProduct("e6d890b0-4e5a-11ec-b6da-dfb7e6b01d2b", "c8bc3d40-3af6-11e9-8e4f-fb10e27e3a41");
    configurator.addSceneProduct("e6d66ae0-4e5a-11ec-94a1-cf20ab6b8fd4", "1bf213e0-3af7-11e9-bb39-dbde969e139c");
    // configurator also aupports adding models without variations
    configurator.addModel("15e26685-fdda-806c-bd62-70f57594ea38");
    
    // output configuration as USDZ - default is glb
    configurator.output = "usdz";
    
    // execute on staging objects - default is production
    configurator.server = "staging";
    
    configurator.get().then((data) => {
        // this says if the object is returned from cache or generated new
        console.log("cache_status - " + data.cache_status);
        // this is the full url to the final generated object
        console.log("filename - " + data.filename);
        // this is the request/file hash used for caching
        console.log("hash - " + data.hash);
    }).catch((err) => {
        console.error(err);
    });

    Virtual Try On (VTO) Example

    const configurator = new PlattarServices.Configurator();
    
    // add SceneProduct and ProductVariation mapping to our configurator
    // if using plattar-api objects, the attributes will be hashed aswell
    configurator.addProduct("bc136a6c-1abf-699b-f122-e72e43b32d2a", "e49e93a0-427f-11ec-acd9-9d5725e9cdf9");
    
    // output configuration as Apple Reality USDZ - default is glb
    // this model will track onto the users-face. The alignment 
    // can be changed via the Plattar CMS!
    configurator.output = "vto";
    
    // execute on staging objects - default is production
    configurator.server = "staging";
    
    configurator.get().then((data) => {
        // this says if the object is returned from cache or generated new
        console.log("cache_status - " + data.cache_status);
        // this is the full url to the final generated object
        console.log("filename - " + data.filename);
        // this is the request/file hash used for caching
        console.log("hash - " + data.hash);
    }).catch((err) => {
        console.error(err);
    });

    Model Converter Example

    const converter = new PlattarServices.ModelConverter();
    
    // the FileModel id, this can be a string or FileModel instance
    converter.model = "0d8c6d90-0b88-11ec-b58b-ffbce2e5da06";
    // output model as USDZ - default is glb
    converter.output = "usdz";
    // execute on staging objects - default is production
    converter.server = "staging";
    
    converter.get().then((data) => {
        // this says if the object is returned from cache or generated new
        console.log("cache_status - " + data.cache_status);
        // this is the full url to the final generated object
        console.log("filename - " + data.filename);
        // this is the request/file hash used for caching
        console.log("hash - " + data.hash);
    }).catch((err) => {
        console.error(err);
    });

    Install

    npm i @plattar/plattar-services

    DownloadsWeekly Downloads

    30

    Version

    1.120.1

    License

    Apache-2.0

    Unpacked Size

    557 kB

    Total Files

    17

    Last publish

    Collaborators

    • plattar-dev