Gerar o proxy Typescript para Store Commerce

  • 15 minutos

O proxy do Commerce abstrai a interface entre o Retail Server e o Commerce Runtime (CRT).

Por exemplo, você pode criar uma nova entidade e lógica comercial como operações de solicitação/resposta no CRT, e pode adicionar uma nova API do Retail Server para expor essa entidade e essas operações de solicitação/resposta. Você deseja acessar a entidade e as operações de solicitação/resposta no Store Commerce para criar lógica de cliente.

Você pode criar manualmente todas as entidades e metadados de solicitação/resposta no Store Commerce e pode acessar o Retail Server usando os parâmetros corretos. O proxy do Commerce reduz esse esforço ao gerar automaticamente o proxy para todas as entidades personalizadas e as operações de solicitação/resposta adicionadas na API do Retail Server.

A ferramenta proxy gera a interface necessária e todos os metadados necessários e abstrai a implementação real. Dessa forma, você pode incluir os arquivos nos projetos de extensão e acessar as APIs e as entidades do Retail Server usando os metadados e a interface que são gerados.

Para gerar o proxy Typescript para Store Commerce, siga estas etapas:

  1. Abra o projeto de modelo do proxy de exemplo de \RetailSDK\Code\SampleExtensions\TypeScriptProxy\TypeScriptProxy.Extensions.StoreHoursSample\Proxies.TypeScriptProxy.Extensions.StoreHoursSample.csproj no Visual Studio. Renomeie-o, se necessário.

  2. Adicione o projeto de extensão do Retail Server como um projeto de referência de projeto a este projeto de modelo de proxy. Remova a referência de projeto StoreHoursSample existente.

  3. Clique com o botão direito do mouse em Proxies.TypeScriptProxy.Extensions.StoreHoursSample.csproj e selecione Editar Proxies.TypeScriptProxy.Extensions.StoreHoursSample.csproj.

  4. No nó RetailServerExtensionAssemblies, especifique o nome do assembly da extensão do Retail Server. O exemplo a seguir mostra como adicionar o nome do assembly.

    <ItemGroup>
    <RetailServerExtensionAssemblies Include="..\..\RetailServer\Extensions.Sample\bin\$(Configuration)\net461\$(AssemblyNamePrefix).RetailServer.Extension.Sample.dll" />
</ItemGroup>

  5. No nó Copiar, atualize o caminho DestinationFolder na pasta de extensão do Store Commerce, de forma que os arquivos de proxy gerados sejam copiados automaticamente para a pasta Extensão de PDV. Os arquivos de proxy gerados também serão copiados em \RetailSDK\Code\SampleExtensions\TypeScriptProxy\TypeScriptProxy.Extensions.StoreHoursSample\DataService. O exemplo a seguir mostra como atualizar o caminho.

    <Copy SourceFiles="@(GeneratedDataServiceContracts)" DestinationFolder="$(SdkRootPath)\POS\Extensions\Sample\DataService" SkipUnchangedFiles="true" />

  6. Depois que as alterações forem concluídas, crie o projeto proxy para gerar os arquivos do proxy Typescript. Quando a compilação for concluída, os arquivos de proxy estarão disponíveis na pasta \RetailSDK\Code\SampleExtensions\TypeScriptProxy\TypeScriptProxy.Extensions.StoreHoursSample\DataService e na pasta especificada no comando Copiar. O caminho e o caminho da pasta podem variar de acordo com a estrutura da pasta.

Para obter mais informações, consulte Criar uma nova API de extensão do Retail Server.